diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index ee19ed5..ab21328 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -7,13 +7,6 @@ on: - "docs/**" - "README.md" - push: - branches: ["main"] - paths-ignore: - - ".github/**" - - "docs/**" - - "README.md" - workflow_dispatch: concurrency: @@ -73,3 +66,15 @@ jobs: with: command: ${{ matrix.cargo.cmd }} args: ${{ matrix.cargo.args }} + + misspell: + name: Spellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: misspell + uses: reviewdog/action-misspell@v1 + with: + github_token: ${{ secrets.github_token }} + locale: "US" diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 1fc103c..0db8d32 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -11,23 +11,18 @@ on: workflow_dispatch: jobs: + run-tests: + uses: ./.github/workflows/ci.yaml + secrets: inherit + release: + needs: [run-tests] runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: fetch-depth: 0 - - name: "Install Rust toolchain (stable)" - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - profile: minimal - default: true - - - name: Cache cargo registry - uses: Swatinem/rust-cache@v2 - - name: "Cocogitto release" id: release uses: cocogitto/cocogitto-action@v3 diff --git a/README.md b/README.md index 298bc5f..e8837af 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# WalletConnectRust -WalletConnect Rust Client +# WalletConnect Rust SDK + +This is the foundation for the WalletConnect Rust SDK. Currently, there's only the core client and the RPC types required to communicate with the Relay. + +See the [basic example](examples/basic_client.rs). + +## `relay_client` + +The core Relay client. Provides access to all available Relay RPC methods to build on top of. + +## `relay_rpc` + +Provides all of the Relay domain types (e.g. `ClientId`, `ProjectId` etc.) as well as auth token generation and validation functionality. + +# License + +[Apache License (Version 2.0)](LICENSE)