diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..59d9e79f --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,22 @@ +name: Docs CI Workflow +on: + push: + branches: + - main + paths: + - "docs/**" + - ".github/workflows/docs.yml" +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v2 + with: + python-version: 3.11 + - run: curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.8.3 python3 - + - run: poetry install + - name: deploy docs + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: poetry run mkdocs gh-deploy --force diff --git a/README.md b/README.md index aec55e1f..a28b615e 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ Postgres 12-16. - [Support](#support) - [Table of Contents](#table-of-contents) - [Installation](#installation) + - [Updating](#updating) - [Client Libraries](#client-libraries) - [SQL Examples](#sql-examples) - [Creating a queue](#creating-a-queue) @@ -47,10 +48,10 @@ Postgres 12-16. ## Installation -The fastest way to get started is by running the Tembo docker image, where PGMQ comes pre-installed. +The fastest way to get started is by running the Tembo Docker image, where PGMQ comes pre-installed in Postgres. ```bash -docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pgmq-pg:latest +docker run -d --name postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pg16-pgmq:latest ``` If you'd like to build from source, you can follow the instructions in [CONTRIBUTING.md](CONTRIBUTING.md).