-
Notifications
You must be signed in to change notification settings - Fork 210
docs: make readme more descriptive #252
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0ab5e9d
docs: make readme more descriptive
niklasad1 88c66e5
Update README.md
niklasad1 e5130e6
Update README.md
niklasad1 0696d94
Update README.md
niklasad1 3ff2daf
Add more projects
niklasad1 742d0de
Update README.md
niklasad1 f45c453
Update README.md
niklasad1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,47 @@ | ||
| # jsonrpsee | ||
|
|
||
| JSON-RPC crate using async/await. | ||
| JSON-RPC library designed for async/await in Rust. | ||
|
|
||
| Designed to be the successor to [ParityTech's JSONRPC crate](https://github.com/paritytech/jsonrpc/). | ||
|
|
||
| Use `cargo doc` to generate the documentation of this crate. | ||
| Support `WebSocket` and `HTTP` transports for both client and server. | ||
|
|
||
| ## Under development | ||
|
|
||
| The library is still under development; do not use in production. | ||
|
|
||
| ## Sub-projects | ||
| - [jsonrpsee-http-client](./http-client) [![crates.io][ws-client-image]][ws-client-url] | ||
| - [jsonrpsee-http-server UNSTABLE/NOT RELEASED](./http-server) [![crates.io][http-server-image]][http-server-url] | ||
| - [jsonrpsee-proc-macros](./proc-macros) [![crates.io][proc-macros-image]][proc-macros-url] | ||
| - [jsonrpsee-ws-client](./ws-client) [![crates.io][ws-client-image]][ws-client-url] | ||
| - [jsonrpsee-ws-server UNSTABLE/NOT RELEASED](./http-server) [![crates.io][http-server-image]][http-server-url] | ||
|
|
||
|
|
||
| [http-client-image]: https://img.shields.io/crates/v/jsonrpsee-http-client.svg | ||
| [http-client-url]: https://crates.io/crates/jsonrpsee-http-client | ||
| [http-server-image]: https://img.shields.io/crates/v/jsonrpsee-http-server.svg | ||
| [http-server-url]: https://crates.io/crates/jsonrpsee-http-server | ||
| [proc-macros-url]: https://crates.io/crates/jsonrpsee-proc-macros | ||
| [proc-macros-image]: https://img.shields.io/crates/v/jsonrpsee-proc-macros.svg | ||
| [ws-client-image]: https://img.shields.io/crates/v/jsonrpsee-ws-client.svg | ||
| [ws-client-url]: https://crates.io/crates/jsonrpsee-ws-client | ||
| [ws-server-image]: https://img.shields.io/crates/v/jsonrpsee-ws-server.svg | ||
| [ws-server-url]: https://crates.io/crates/jsonrpsee-ws-server | ||
|
|
||
| ## Examples | ||
|
|
||
| - [HTTP](./examples/examples/http.rs) | ||
| - [WebSocket](./examples/examples/ws.rs) | ||
| - [WebSocket pubsub](./examples/examples/ws_subscription.rs) | ||
|
|
||
| ## Roadmap | ||
|
|
||
| See [tracking issue for next stable release](https://github.com/paritytech/jsonrpsee/issues/251) | ||
|
|
||
| ## Users | ||
|
|
||
| If your project uses `jsonrpsee` we would like to know. Please open a pull request and add your project to the list below: | ||
| - [substrate-subxt](https://github.com/paritytech/substrate-subxt) | ||
| - [parity bridges common](https://github.com/paritytech/parity-bridges-common) | ||
| - [remote externalities](https://github.com/paritytech/substrate/tree/master/utils/frame/remote-externalities) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bridges?
remote-externalities?