From 0a44b9f064d4e770db68ab175628a1b799226d76 Mon Sep 17 00:00:00 2001
From: Xiliang Chen <xlchen1291@gmail.com>
Date: Thu, 5 Mar 2020 21:02:54 +1300
Subject: [PATCH] Feature/brief doc (#112)

* auction, oracle and prices brief documentation

* add gradually-update and schedule-update brief doc

Co-authored-by: Ermal Kaleci <ermalkaleci@gmail.com>
---
 gradually-update/README.md | 5 +++++
 schedule-update/README.md  | 5 +++++
 2 files changed, 10 insertions(+)
 create mode 100644 gradually-update/README.md
 create mode 100644 schedule-update/README.md

diff --git a/gradually-update/README.md b/gradually-update/README.md
new file mode 100644
index 0000000..dfa26e4
--- /dev/null
+++ b/gradually-update/README.md
@@ -0,0 +1,5 @@
+# Gradually-update module
+
+### Overview
+
+Gradually-update module provides a way to adjust numeric parameter such as stability fee or liquidation gradually. The update code should be able to handle different numeric types such as `u32`, `u128`, `Permill`, `FixedU128`. All the values are assumed to be little-endian and unsigned.
diff --git a/schedule-update/README.md b/schedule-update/README.md
new file mode 100644
index 0000000..638ccbb
--- /dev/null
+++ b/schedule-update/README.md
@@ -0,0 +1,5 @@
+# Schedule-update module
+
+### 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.
-- 
GitLab