Skip to content

Commit

Permalink
docs(link): add more references
Browse files Browse the repository at this point in the history
  • Loading branch information
phnaharris committed Jan 13, 2024
1 parent 5004c05 commit 3bfbccf
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
[![codecov](https://codecov.io/gh/phnaharris/symbiosis-api-rs/graph/badge.svg?token=AWZJZFZCMH)](https://codecov.io/gh/phnaharris/symbiosis-api-rs)
[![Build Status](https://github.com/phnaharris/symbiosis-api-rs/actions/workflows/main.yml/badge.svg)](https://github.com/phnaharris/symbiosis-api-rs/actions/workflows/main.yml)

A high-level binding for Symbiosis API, written in Rust.
A high-level binding for [`Symbiosis API`], written in Rust.

Symbiosis API allows you to integrate the functionalities of the Symbiosis Protocol into your
application, platform or protocol.
[`Symbiosis API`] allows you to integrate the functionalities of the Symbiosis Protocol into
your application, platform or protocol.

By integrating the Symbiosis API, you can quickly and effectively enable decentralized
cross-chain swaps and cross-chain liquidity management for your users.
Expand Down Expand Up @@ -66,6 +66,9 @@ async fn main() -> Result<(), anyhow::Error> {
}
```

For more examples, take a look at the `examples/` directory.
For more examples, take a look at the [examples] directory.

This crate design based on https://plume.benboeckel.net/~/JustAnotherBlog/designing-rust-bindings-for-rest-ap-is
[reqwest]: https://crates.io/crates/reqwest
[serde]: https://crates.io/crates/serde
[`Symbiosis API`]: https://docs.symbiosis.finance/developer-tools/symbiosis-api
[examples]: https://github.com/phnaharris/symbiosis-api-rs/tree/main/examples
13 changes: 8 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! A high-level binding for Symbiosis API, written in Rust.
//! A high-level binding for [`Symbiosis API`], written in Rust.
//!
//! Symbiosis API allows you to integrate the functionalities of the Symbiosis Protocol into your
//! application, platform or protocol.
//! [`Symbiosis API`] allows you to integrate the functionalities of the Symbiosis Protocol into
//! your application, platform or protocol.
//!
//! By integrating the Symbiosis API, you can quickly and effectively enable decentralized
//! cross-chain swaps and cross-chain liquidity management for your users.
Expand Down Expand Up @@ -59,9 +59,12 @@
//! }
//! ```
//!
//! For more examples, take a look at the `examples/` directory.
//! For more examples, take a look at the [examples] directory.
//!
//! This crate design based on https://plume.benboeckel.net/~/JustAnotherBlog/designing-rust-bindings-for-rest-ap-is
//! [reqwest]: https://crates.io/crates/reqwest
//! [serde]: https://crates.io/crates/serde
//! [`Symbiosis API`]: https://docs.symbiosis.finance/developer-tools/symbiosis-api
//! [examples]: https://github.com/phnaharris/symbiosis-api-rs/tree/main/examples

#![deny(missing_docs)]
#![warn(missing_debug_implementations, rust_2018_idioms, rustdoc::all)]
Expand Down

0 comments on commit 3bfbccf

Please sign in to comment.