diff --git a/README.md b/README.md index 1a42c89..184adce 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Sinkr Synchronize data to your clients in real time with websockets. Deploy on your own infrastructure! +## WIP +This library is WIP as I test things to make sure they work, with the goal of achieving near parity with Pusher. Use at your own risk, but if you do run into problems, PRs/issues are welcome :) + ## How to use To deploy your own Sinkr instance, follow these steps: @@ -39,4 +42,4 @@ To deploy your own Sinkr instance, follow these steps: 1. For TypeScript apps of any kind, simply install `@sinkr/core` from JSR. 2. For React apps, install `@sinkr/react` from JSR. This also exports `@sinkr/core` so installing both is not strictly necessary. 3. For Python apps of any kind, install `sinkr` from PyPI -7. Done! Start sending and receiving messages! \ No newline at end of file +7. Done! Start sending and receiving messages!