Skip to content

Commit

Permalink
doc: add crate documentation to 'sails-rs' (#471)
Browse files Browse the repository at this point in the history
  • Loading branch information
DennisInSky authored Aug 15, 2024
1 parent fa422c2 commit f090dc5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
Sails is a library for bringing your experience of writing applications utilizing
[Gear Protocol](https://gear-tech.io/) to the next level of simplicity and
clarity. It deals with things like:
- eliminating
the necessity of writing some low-level boilerplate code and letting you to stay
focused on your business problem
- generated [IDL](https://en.wikipedia.org/wiki/Interface_description_language) file for
your application
- eliminating the necessity of writing some low-level boilerplate code and letting
you to stay focused on your business problem
- generated [IDL](https://en.wikipedia.org/wiki/Interface_description_language) file
for your application
- generated client allowing to interact with your application from code written in
different languages and executed in different runtimes
different languages and executed in different runtimes

---

> [!NOTE]
> The Sails library is published under the name `sails-rs` on `crates-io`.
>
> Versions "version <= 0.2.1" are pinned to v1.4.2 of gear libs.
>
> Versions "0.2.1 < version <= 0.3.0" are pinned to v1.5.0 of gear libs.
## Getting started
Expand Down Expand Up @@ -346,7 +346,7 @@ a clearer way. Currently, Sails can generate client code for Rust and TypeScript

When it comes to Rust, there are two options:
- Use generated code that can encode and decode byte payloads for you, allowing you
to continue using functions that send raw bytes.
to continue using functions that send raw bytes.
- Use fully generated code that can interact with your application in an RPC style.

For TypeScript see [generated clients](js/README.md#generate-library-from-idl)
Expand Down
1 change: 1 addition & 0 deletions rs/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![doc = include_str!("../../README.md")]
#![no_std]

#[cfg(feature = "mockall")]
Expand Down

0 comments on commit f090dc5

Please sign in to comment.