diff --git a/README.md b/README.md index 62066bc..a633a46 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # libchat -Supporting library for Logos-chat + +Supporting library for Logos-chat. + +## Prerequisites + +Install Rust via [rustup](https://rust-lang.org/tools/install/): + +## Quick Start + +### Using Cargo + +```bash +# Build +cargo build + +# Run tests +cargo test + +# Run examples +cargo run --example double_ratchet_basic +``` + +### Using Just + +Install [just](https://github.com/casey/just) to manage complex tasks. + +On MacOS, you can install it via Homebrew: + +```bash +brew install just +``` + +After that, run: + +```bash +# Build +just build + +# Run tests +just test + +# Run all examples +just run-examples +``` diff --git a/double-ratchets/README.md b/double-ratchets/README.md index 974deda..345510d 100644 --- a/double-ratchets/README.md +++ b/double-ratchets/README.md @@ -20,8 +20,7 @@ Run examples, ```bash cargo run --example double_ratchet_basic -cargo run --example storage_demo --features storage -cargo run --example storage_demo --features sqlcipher +cargo run --example storage_demo ``` Run Nim FFI example, diff --git a/justfile b/justfile new file mode 100644 index 0000000..a7b192e --- /dev/null +++ b/justfile @@ -0,0 +1,13 @@ +# The first receipt is the default task, run with `just` +build: + cargo build + +test: + cargo test + +# Run all examples +run-examples: + cargo run --example double_ratchet_basic + cargo run --example serialization_demo + cargo run --example storage_demo + cargo run --example out_of_order_demo