Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
igorls committed Mar 26, 2024
1 parent b34d1eb commit a5ecc83
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Rust Abieos

[crates-badge]: https://img.shields.io/crates/v/rs_abieos.svg
[crates-url]: https://crates.io/crates/rs_abieos

[![Crates.io][crates-badge]][crates-url]

#### [API Documentation](https://docs.rs/rs_abieos/)

`rs_abieos` is a Rust library that provides a wrapper for the `abieos` C++ library. It allows you to handle data from
Antelope blockchains by providing functionalities such as converting between binary and JSON formats for ABI files,
converting between native and string names, and more.

This wrapper is currently based on the vanilla version of the [AntelopeIO/abieos](https://github.com/AntelopeIO/abieos)

Test cases are being completely rewritten in Rust. They can be found in the `tests` directory.
_Test cases are being completely rewritten in Rust. They can be found in the `tests` directory._

## Pre requisites
## Requirements

- Linux
- C++ toolchain. You can use alternative compilers to build the library.
Expand Down Expand Up @@ -38,16 +45,6 @@ cargo build
CXX=clang++-18 CC=clang-18 cargo build
```

### Testing

To run the test cases, use the following command:

```bash
cargo test
# or
CXX=clang++-18 CC=clang-18 cargo test
```

## Quick Usage Example

Short example of how to use the library on new Rust binary project:
Expand Down Expand Up @@ -149,6 +146,16 @@ fn main() {

`bin-src/main.rs` contains a more detailed executable example that demonstrates multiple use cases for the library.

## API Documentation
Please refer to the library's [API documentation](https://docs.rs/rs_abieos/0.1.3/rs_abieos) for more detailed information on each function.

### Library Development

#### Testing

To run the test cases, use the following command:

Please refer to the library's API documentation for more detailed information on each function.
```bash
cargo test
# or
CXX=clang++-18 CC=clang-18 cargo test
```

0 comments on commit a5ecc83

Please sign in to comment.