Skip to content

Commit

Permalink
doc: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onsails committed Nov 14, 2023
1 parent 09009e5 commit a30d73a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Haqq RPC Clients

This repo contains RPC clients — generated with [buf.build](https://buf.build), patched rough edges and improved with some useful helpers.

## Rust Client

Rust client is fully functional, supports [gRPC](https://github.com/haqq-network/haqq-rpc-clients/blob/master/tests/grpc.rs) and [Rest](https://github.com/haqq-network/haqq-rpc-clients/blob/master/tests/rest.rs) enpoints.

Not published in crates yet but will be any time soon. In order to use, add to your project's `Cargo.toml`:

* `haqq-proto = {git = "https://github.com/haqq-network/haqq-rpc-clients"}` — for gRPC endpoints
* `haqq-rest = {git = "https://github.com/haqq-network/haqq-rpc-clients"}` — for REST endpoints

## TypeScript Client

Currently only structs are generated in [web](web) folder.

TODO:

[ ] package.json and other packaging-related files
[ ] tests with usage examples

0 comments on commit a30d73a

Please sign in to comment.