docs(formula): add formula docs

barajs · Jan 6, 2020 · f82cbb2 · f82cbb2 · vercel · Jan 6, 2020
1 parent d470c76
commit f82cbb2
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 1 deletion.
diff --git a/docs/formula/installation.md b/docs/formula/installation.md
@@ -0,0 +1,20 @@
+---
+id: installation
+title: Installation
+---
+
+```
+yarn add -E @barajs/formula
+```
+
+# What is a Bara formula?
+
+Formula is the standalone and independence library that would boost up your functional programming speed.
+
+Each formula is a curry function which is designed to fit with Bara  application.
+
+ As each function is a pure function, you can easily extends or build a new one.
+
+## Future plan
+
+In the future we will distribute every function as a stand-alone package to reduces the size of your application bundle.
diff --git a/docs/formula/object.md b/docs/formula/object.md
@@ -0,0 +1,15 @@
+---
+id: object-formula
+title: Object Formula
+---
+
+# lensProp
+
+Get a value of an object's property in unlimited nested.
+
+Inspri
+
+```
+import {lensProp} from "@barajs/formula"
+
+
diff --git a/sidebars.json b/sidebars.json
@@ -5,8 +5,13 @@
       "api",
       {
         "type": "subcategory",
-        "label": "Core Package",
+        "label": "Core",
         "ids": ["core/installation", "core/app"]
+      },
+      {
+        "type": "subcategory",
+        "label": "Formula",
+        "ids": ["formula/installation", "formula/object"]
       }
     ],
     "Examples": ["doc3"]