From f7412bcf514541aa3ba01f1761be80d74eeff4ac Mon Sep 17 00:00:00 2001
From: Xiliang Chen <xlchen1291@gmail.com>
Date: Thu, 23 Apr 2020 13:39:19 +1200
Subject: [PATCH] update readme (#144)
* update readme
* updater eadme
---
README.md | 20 ++++++++++++--------
schedule-update/README.md | 2 +-
2 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 4650704..4388f09 100644
--- a/README.md
+++ b/README.md
@@ -3,22 +3,26 @@ The Open Runtime Module Library (ORML) is a community maintained collection of S
## Runtime Modules Overview
-- orml-traits
+- [orml-traits](./traits)
- Shared traits including `BasicCurrency`, `MultiCurrency`, `Auction` and more.
-- orml-utilities
+- [orml-utilities](./utilities)
- Various utilities including `FixedU128` and `LinkedList`.
-- orml-tokens
+- [orml-tokens](./tokens)
- Fungible tokens module that implements `MultiCurrency` trait.
-- orml-currencies
+- [orml-currencies](./currencies)
- Provide `MultiCurrency` implementation using `pallet-balances` and `orml-tokens` module.
-- orml-oracle
+- [orml-oracle](./oracle)
- Oracle module that makes off-chain data available on-chain.
-- orml-prices
+- [orml-prices](./prices)
- Provide basic asset price abstraction.
-- orml-auction
+- [orml-auction](./auction)
- Auction module that implements `Auction` trait.
-- orml-vesting
+- [orml-vesting](./vesting)
- Provides scheduled balance locking mechanism, in a *graded vesting* way.
+- [orml-gradually-update](./gradually-update)
+ - Provides why to adjuest numeric parameter gradually over a period of time.
+- [orml-schedule-update](./schedule-update)
+ - Provides way to schedule a call to be dispatched at later block.
## Installation
diff --git a/schedule-update/README.md b/schedule-update/README.md
index 638ccbb..4d0e7af 100644
--- a/schedule-update/README.md
+++ b/schedule-update/README.md
@@ -2,4 +2,4 @@
### Overview
-Schedule-update module provides a way to allow an update to be dispatched at later block. This is Useful for council to dispatch a delayed update so other have time to review and learn the change. Council also have chance to cancel the update if any issues were found.
+Schedule-update module provides a way to allow an update to be dispatched at later block. This is useful for council to dispatch a delayed update so other have time to review and learn the change. Council also have chance to cancel the update if any issues were found.
--
GitLab