diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 8ddce5e..aa6c00e 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -51,7 +51,7 @@ jobs: cargo doc --lib --no-deps rm -f target/doc/.lock cp -r target/doc _site - echo "" > _site/index.html + echo "" > _site/index.html echo "Taking care of pedantic permissions requirements required by GitHub Pages" chmod -R +rX _site id: docgen diff --git a/README.md b/README.md index d8dbd48..87304f9 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This *postal service* gateway implements the XMTP transport for registration, in ## Quick Start (Development) - [READ THE DOCS](https://xmtp.github.io/xps-gateway) +- [CONTRIBUTING](CONTRIBUTING.md) ### Dev Containers Development diff --git a/xps-gateway/README.md b/xps-gateway/README.md deleted file mode 100644 index b21661d..0000000 --- a/xps-gateway/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# XMTP Postal Service - -[![Test](https://github.com/xmtp/postal_service/actions/workflows/ci-image.yml/badge.svg)](https://github.com/xmtp/postal_service/actions/workflows/ci-image.yml) - -This postal service supports the XMTP inbox backed by a decentralized network. - -## Quick Start (Dev Containers) - -This project supports containerized development. From Visual Studio Code Dev Containers extension specify the Dockerfile as the target: - -`Reopen in Container` - -or - -Command line build using docker - -```bash -docker build . -t xmtp_postal_service:1 -```