Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DenisCarriere committed Oct 7, 2023
1 parent 4aa9142 commit b757d7a
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,29 @@
## Quickstart

```bash
$ bun install
$ bun run dev
$ bunx pinax-network/substreams-sink-websockets
```

## 📖 References

- [**Substreams** documentation](https://substreams.streamingfast.io/)
- [Bun WebSockets](https://bun.sh/docs/api/websockets)


## `.env` Environment variables

```env
PORT=3000
PUBLIC_KEY=...
```

## Help

```
$ substreams-service-websockets --help
## 📖 References

TO-DO...
```
- [**Substreams** documentation](https://substreams.streamingfast.io/)
- [Bun WebSockets](https://bun.sh/docs/api/websockets)

## Features

- [x] Accept Substreams Webhook message `POST /`
- [ ] Client connect to WebSocket service
- [x] Client connect to WebSocket service
- [x] Verify tweetnacl Substreams Webhook message
- [ ] Send WebSocket messages
- [ ] Unit testing
- [ ] Prometheus Metrics `GET /metrics`
- [ ] Health check `GET /health`
- [x] Send WebSocket messages
- [x] Unit testing
- [x] Prometheus Metrics `GET /metrics`
- [x] Health check `GET /health`
- [x] Banner `GET /`
- [ ] Commander CLI

0 comments on commit b757d7a

Please sign in to comment.