Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ilbertt committed Oct 18, 2023
1 parent 504f223 commit 8d311cc
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# ic-websocket-cdk-mo

[![mops](https://oknww-riaaa-aaaam-qaf6a-cai.raw.ic0.app/badge/mops/ic-websocket-cdk)](https://mops.one/ic-websocket-cdk)

This repository contains the Motoko implementation of IC WebSocket CDK. For more information about IC WebSockets, see [IC WebSocket Gateway](https://github.com/omnia-network/ic-websocket-gateway).

> ⚠️ This library is still in development and is not ready for production use. Expect breaking changes.
## Installation

You can install the library using [mops](https://mops.one):
Expand All @@ -15,7 +14,7 @@ mops add ic-websocket-cdk

## Usage

TODO: Add usage instructions
Refer to the [ic-websockets-pingpong-mo](https://github.com/iamenochchirima/ic-websockets-pingpong-mo) repository for an example of how to use this library.

### Candid interface
In order for the frontend clients and the Gateway to work properly, the canister must expose some specific methods in its Candid interface, between the custom methods that you've implemented for your logic. A valid Candid interface for the canister is the following:
Expand Down

0 comments on commit 8d311cc

Please sign in to comment.