Skip to content

Commit

Permalink
[docs] everyone loves emojis!
Browse files Browse the repository at this point in the history
  • Loading branch information
tzemanovic committed Oct 7, 2021
1 parent 85a448b commit f689a18
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

This is an implementation of the Anoma ledger in Rust.

## Docs
## 📓Docs

- [docs](https://anoma.github.io/anoma/): built from [docs mdBook](./docs/)
- [rustdoc](https://anoma.github.io/anoma/rustdoc/anoma/): built from the source
Expand All @@ -18,7 +18,7 @@ This is an implementation of the Anoma ledger in Rust.

> Here lay dragons: this codebase is still experimental, try at your own risk!
## Installing
## 💾Installing

There's a single command to build and install Anoma executables from source (the node, the client and the wallet). This command will also verify that [Tendermint](#dependencies) with a compatible version is available and if not, attempt to install it.

Expand All @@ -30,7 +30,7 @@ After installation, the main `anoma` executable will be available on path.

To find how to use it, check out the [User Guide section of the docs](https://anoma.github.io/anoma/user-guide/).

### Development
## ⚙️Development

```shell
# Build the provided validity predicate, transaction and matchmaker wasm modules
Expand Down Expand Up @@ -58,7 +58,7 @@ make fmt
make clippy
```

## Logging
## 🧾Logging

To change the log level, set `ANOMA_LOG` environment variable to one of:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/install.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Install Anoma
# 💾Install Anoma

There's a single command to build and install Anoma executables from source (the node, the client and the wallet). This command will also verify that Tendermint with a compatible version is available and if not, attempt to install it.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/user-guide/intent-gossip-and-matchmaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ cargo run --bin anoman gossip --rpc "127.0.0.1:39111" --matchmaker-path wasm/mm_

This pre-built matchmaker implementation is [the fungible token exchange `mm_token_exch`](https://github.com/anoma/anoma/blob/master/wasm/wasm_source/src/mm_token_exch.rs), that is being used together with [the pre-built `tx_from_intent` transaction WASM](https://github.com/anoma/anoma/blob/master/wasm/wasm_source/src/lib.rs) to submit transaction from matched intents to the ledger.

## Example intents
## Example intents

1) We'll be using these addresses in the intents:

Expand Down Expand Up @@ -53,7 +53,7 @@ This pre-built matchmaker implementation is [the fungible token exchange `mm_tok

The matchmaker should find a match from these intents and submit a transaction to the ledger that performs the n-party transfers of tokens.

## Custom matchmaker
## 🤝Custom matchmaker

A custom matchmaker code can be built from [`wasm/mm_template`](https://github.com/anoma/anoma/tree/master/wasm/mm_template).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/ledger/customize.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ On this page, we'll cover how to tailor your account(s) to your use-case with cu

We currently only support Rust for custom validity predicates and transactions via WASM, but expect many more options to be available in the future!

## Anoma accounts primer
## 👩🏽‍🏫Anoma accounts primer

Instead of the common smart contract design, in Anoma, all the accounts follow the same basic principles. Each account has exactly one validity predicate. Any transaction that attempts to make some storage modifications will trigger validity predicates of each account whose storage has been modified by it. Validity predicates are stateless functions that decide if an account accepts the transaction.

Expand Down

0 comments on commit f689a18

Please sign in to comment.