📝 docs: add user guide

iFaceless · Oct 5, 2019 · 3531c09 · 3531c09
1 parent 0487f3a
commit 3531c09
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -158,6 +158,8 @@ func main()  {
 
 ```
 
+To learn more about [portal](https://github.com/iFaceless/portal), please read the [User Guide](./USERGUIDE.md)~ 
+
 # License
 
 [portal](https://github.com/iFaceless/portal) is licensed under the [MIT license](./LICENSE). Please feel free and have fun~
diff --git a/USERGUIDE.md b/USERGUIDE.md
@@ -0,0 +1,21 @@
+PORTAL USER GUIDE
+======================
+
+Let [portal](https://github.com/iFaceless/portal) worry about trivial details, say goodbye to boilerplate code (our final goal)!
+
+# Special Tags
+## Load Data from Model's Attribute: `attr`
+
+## Load Data from Custom Method: `meth`
+
+## Load Data Asynchronously: `async`
+
+## Nested Schema: `nested`
+
+## Field Filtering: `only` & `exclude`
+
+## Set Const Value for Field: `const`
+
+# Embedding Schema
+
+# Custom Field Type