search

yufuquant / rust-bybit

Rust API connector for Bybit's WebSockets APIs.
MIT License
35 stars 10 forks source link

docs: Describe project goals #21

Closed EricCrosson closed 2 years ago

EricCrosson commented 2 years ago

Following a conversation here, this commit tries to document project goals. We can use these goals as a compass to decide which changes are in scope and which are out of scope.

Currently, this project is meant to be a lightweight layer for interacting with Bybit's WebSocket API. Performance is king, and this means many conveniences may have to be built into separate packages that build upon this package.

This should make it easier to bring this project into a "complete" state.

EricCrosson commented 2 years ago

@jukanntenn, I tried to document the project goals as I understand them today. Please let me know if I am incorrect!