From 84d2f8c23339a9e11b42a741ea57c79d2b48e263 Mon Sep 17 00:00:00 2001 From: Xiliang Chen <xlchen1291@gmail.com> Date: Wed, 4 Nov 2020 11:32:56 +1300 Subject: [PATCH] Update README.md --- README.md | 43 ++++++------------------------------------- 1 file changed, 6 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index bfc5d8d..62392d7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ # open-runtime-module-library + +[](https://crates.io/search?q=orml) +[](https://github.com/open-web3-stack/open-runtime-module-library/blob/master/LICENSE) + The Open Runtime Module Library (ORML) is a community maintained collection of Substrate runtime modules. ## Runtime Modules Overview @@ -20,44 +24,9 @@ The Open Runtime Module Library (ORML) is a community maintained collection of S - [orml-gradually-update](./gradually-update) - Provides way to adjust numeric parameter gradually over a period of time. -## Installation - -### Runtime `Cargo.toml` - -To add an `ORML` module to your runtime, simply include the following to your runtime's `Cargo.toml` file. For instance, to add `orml-tokens` module: - -```TOML -[dependencies] -# --snip-- -orml-tokens = { git = "https://github.com/laminar-protocol/open-runtime-module-library.git", default-features = false } -``` - -and update your runtime's `std` feature to include this module: - -```TOML -std = [ - # --snip-- - 'orml-tokens/std', -] -``` - -### Runtime `lib.rs` - -You should implement it's trait like so: - -```rust -/// Used for orml_tokens -impl orml_tokens::Trait for Runtime { - type Event = Event; - // --snip-- -} -``` - -and include it in your `construct_runtime!` macro: +## Example -```rust -Tokens: orml_tokens::{Module, Storage, Call, Event<T>, Config<T>}, -``` +Checkout [orml-workshop](https://github.com/xlc/orml-workshop) for example usage. ## Development -- GitLab