Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# ajj: A Json-RPC Router

[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]
[![CI status][ci-badge]][ci-url]
[![MIT licensed][license-badge]][license-url]

[crates-badge]: https://img.shields.io/crates/v/ajj.svg
[crates-url]: https://crates.io/crates/ajj
[docs-badge]: https://img.shields.io/docsrs/ajj
[docs-url]: https://docs.rs/ajj
[ci-badge]: https://github.com/init4tech/ajj/actions/workflows/rust.yml/badge.svg
[ci-url]: https://github.com/init4tech/ajj/actions/workflows/rust.yml
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/init4tech/ajj/blob/main/LICENSE

A general-purpose, batteries-included [JSON-RPC 2.0] router, inspired by
[axum]'s routing system.

Expand Down Expand Up @@ -49,7 +63,7 @@ let router = Router::<u64>::new()
## Feature flags

- `axum` - implements the `tower::Service` trait for `Router`, allowing it to
be used as an [axum]() handler.
be used as an [axum] handler.
- `pubsub` - adds traits and tasks for serving the router over streaming
interfaces.
- `ws` - adds implementations of the `pubsub` traits for
Expand All @@ -71,7 +85,7 @@ implementations.

See the [crate documentation on docs.rs] for more detailed examples.

## Specification Complinace
## Specification Compliance

`ajj` aims to be fully compliant with the [JSON-RPC 2.0] specification. If any
issues are found, please [open an issue]!
Expand Down