diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..aa7109313 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,26 @@ +name: docs + +on: + push: + branches: + - master + +env: + nim-version: stable + nim-src: waku/waku.nim + deploy-dir: .gh-pages + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: jiro4989/setup-nim-action@v1 + with: + nim-version: ${{ env.nim-version }} + - run: nimble doc --index:on --project --out:${{ env.deploy-dir }} ${{ env.nim-src }} + - name: Deploy documents + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ${{ env.deploy-dir }} diff --git a/waku/waku.nim b/waku/waku.nim new file mode 100644 index 000000000..530614235 --- /dev/null +++ b/waku/waku.nim @@ -0,0 +1,11 @@ +# Waku +# +# Licenses: +# - MIT ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT) +# - APACHEv2 ([LICENSE-APACHEv2](../LICENSE-APACHEv2) or https://www.apache.org/licenses/LICENSE-2.0) + +## An implementation of the [Waku v1](https://specs.vac.dev/specs/waku/waku.html) and [Waku v2](https://specs.vac.dev/specs/waku/v2/waku-v2.html) in nim. +import v2/node/wakunode2, v1/node/wakunode1, waku_types +export wakunode2 +export wakunode1 +export waku_types