Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Wundero authored Jan 8, 2025
1 parent ef84301 commit c50107c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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!
7. Done! Start sending and receiving messages!

0 comments on commit c50107c

Please sign in to comment.