Documentations added

Author: vinzdeveloper

README.md

@@ -1,2 +1,40 @@
-# json-rule-editor
-Json based decision editor
+## json-rule-editor
+
+### Getting Started
+
+Json rule editor is an unornamented web interface tool to manage your business rules and decision outcomes. A single page application to effortlesly upload / create business rules via json files. Since the lightweight libraries are the new normal in web applications, possessing logics in json file will be a effective way to manage the application code. Having said that redudancy can be detoured by discarding the other business rule file format such as xml or excel, which is often hectic to parse and adding complications to developer.
+
+Process to implement json rule file in your application follows
+
+- Generate rule file using json rule editor
+- Place the generated file in your application folder,
+- and pass the relative path of file and input parameters into json rules engine to get the output.
+
+Facinating feature it implies is, we can validate the business decisions instantly once after rules are added. Thus, ensuring expected outcome is returned from the rule sheet before generates the file. Consequently it eliminates issues at first place when rules are being created instead of identifing at later stage of development or testing.
+
+### Usage:
+
+To launch the json rule editor tool, you can do either of the below 
+1. 	Click [json rule editor](https://www.json-rule-editor.com) 
+2.  or install it locally via npm `npm install json-rule-editor`
+
+The detailed steps to create json rule file using this tool in [next section](https://vinzdeveloper.github.io/json-rule-editor/docs/create-rules.html).
+
+### Thanks to json-rules-engine:
+
+In principle, json rules engine is an integral backbone library should be added into your application to process the business rules created from this rule editor. It is highly recommended to go through the json rules engine concepts and explore the features it offers.
+
+Install json rules engine in your application using the steps mentioned in the [npm](https://www.npmjs.com/package/json-rules-engine)
+
+This documentation explains the steps to create / manage rules in json rule editor tool.
+
+This documentation covers,
+
+1. [Why Rule Engine?](https://vinzdeveloper.github.io/json-rule-editor/docs/rule-engine.html)
+2. [Create Business Decisions using Json Rule Editor](https://vinzdeveloper.github.io/json-rule-editor/docs/create-rules.html)
+3. [Implementation of rules in application](https://vinzdeveloper.github.io/json-rule-editor/docs/implementation.html)
+4. [Manage existing rule](https://vinzdeveloper.github.io/json-rule-editor/docs/manage-rules.html)
+5. [More examples in Decisions](https://vinzdeveloper.github.io/json-rule-editor/docs/decisions.html)
+6. [Advanced examples](https://vinzdeveloper.github.io/json-rule-editor/docs/advanced.html)
+
+

docs/advanced.md

@@ -0,0 +1,53 @@
+## json-rule-editor
+
+### Advanced concepts of json-rules-engine
+
+json rules engine provides other feature to load the input fact value aynchronously from remote system via api.
+Go through the advance concepts explained in detail [here](https://github.com/CacheControl/json-rules-engine) to understand better.
+
+We will take the same example *"Employee-Salary"* to handle path parameter. Lets assume, `designation`, `experience` and `type` fact values are coming via api.
+
+Step by Step process explained below to add path parameter along with facts in decisions
+
+***Step1: Add object reference***
+
+1. Go to Facts tab
+2. Click **Add icon** at right corner of tool bar.
+3. Specify the fact object name and select **object** as type
+4. Click **Add facts** button
+
+    ![create path fact](https://vinzdeveloper.github.io/json-rule-editor/docs/images/path-fact.png)
+
+***Step2: Add path parameter reference***
+
+1. Go to Decisions tab
+2. Click **Add icon** at right corner of tool bar.
+3. Select all / any in **"Step 1: Add Toplevel"**
+4. Select Add facts menu in **"Step 2: Add / Remove facts"**
+5. Select **Add path** icon at top right corner of panel.
+6. Give fact object name, operator, value along with path parameter as below
+
+    ![create path decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/path-decisions1.png)
+
+7. Add other facts with path parameter
+
+    ![create path decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/path-decisions2.png)
+
+8. Click **Add Rulecase** button
+
+***Caution***
+
+> You can’t validate such path parameter decisions in our rule editor though, because these values are coming from real time api,
+> so its not possible to retrieve and validate such decisions in this tool.
+
+### Add more parameters in output
+
+Sometimes, it would make sense to add more values along with output value. In order to add extra values, you can click ***‘Add Params’*** icon in output panel. You can add any number of key value pairs along with the output type. 
+
+![create path decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/output-params.png)
+
+Feel free to raise issues or concerns in [github](https://github.com/vinzdeveloper/json-rule-editor/issues) or contact here <vinzdeveloper@gmail.com>. Happy to look into your concerns!!
+
+[Go back to previous page](https://vinzdeveloper.github.io/json-rule-editor/docs/decisions.html)
+
+[Go Home](https://vinzdeveloper.github.io/json-rule-editor/)

docs/create-rules.md

@@ -0,0 +1,113 @@
+## json-rule-editor
+
+### Create Decisions
+
+Primarily, we are going to deal with two factors 1) Facts and 2) Decisions across this tool.
+
+***Facts***
+
+Its an entity or attribute helps to build your business decisions. It supports four data types such as number, string, array and object - inline with json rules engine.
+
+***Decisions***
+
+It is actually business rule conditions which contains the possible facts values and associated outcome type. Here you can define any number of business decision outcomes under single rule.
+
+*Note:*
+
+> Its good practise to separate your business rules into different ruleset files based on the use cases.
+
+Lets see the step by step process starting from creating facts to generating the ruleset file.  
+
+***Step1: Create new ruleset file***
+
+1. Launch [json rule editor](www.json-rule-editor.com) or install locally via npm
+2. Click **Create button** (Note: Upload functioanlity is explained in next section)
+
+    ![create new rule](https://vinzdeveloper.github.io/json-rule-editor/docs/images/create-upload.png)
+
+***Step2: Specify rule name***
+
+1. Specify rule name and click **Create button**
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/create.png)
+
+***Step3: Add new fact***
+
+1. Click **Create Facts** button at information message panel
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/facts1.png)
+
+2. Give fact name and data type such as string, number or array
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/facts2.png)
+
+3. Add as many as fact you need to build your decisions
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/fact3.png)
+
+
+***Step4: Add new decisions***
+
+Go to Decisions tab
+
+1. Click **Create Decisions** button at information message panel
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/decision1.png)
+
+2. Select all / any in **"Step 1: Add Toplevel"**
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/decision2.png)
+
+3. Select Add facts menu in **"Step 2: Add / Remove facts"**
+
+4. Select the fact, operator and value
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/decision3.png)
+
+5. Add necessary facts and you will see something as below
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/decision4.png)
+
+6. Select the Add Outcome in **"Step 3: Add outcome""** and specify the type value. 
+    
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/decision5.png)
+
+7. Click **Add Rulecase** button.
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/decision6.png)
+
+***Step5: Validate decisions***
+
+Go to Validate tab
+
+1. Specify the values against facts
+2. Click Validate Ruleset button
+
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/validate.png)
+
+*Note: Please keep in mind when adding facts and value*
+> Incase expected values are not getting displayed, go to Decisions tab and cross check the values.
+> Values are case sensitive and perform strict equality comparison ( === ).
+
+
+***Step5: Generate rule sheet***
+
+Go to Generate tab
+
+1. Click generate button if all required decisions are added.
+
+    ![rule name](https://vinzdeveloper.github.io/json-rule-editor/docs/images/generate.png)
+
+*Note:*
+
+> Json rule file will be generated at your default browser download folder.
+
+
+
+
+[Next section - Implementation of Json rules in application](https://vinzdeveloper.github.io/json-rule-editor/docs/implementation.html)
+
+[Go back to previous page](https://vinzdeveloper.github.io/json-rule-editor/docs/rule-engine.html)
+
+[Go Home](https://vinzdeveloper.github.io/json-rule-editor/)

docs/decisions.md

@@ -0,0 +1,71 @@
+## json-rule-editor
+
+### More examples in Decisions
+
+We have seen simple rule structure example before which has just one top node *"all"*. However, Json rules engine offers many features which will be really useful to manage business decisions effectively.
+
+***Nested ‘all’ or ‘any’***
+
+You can configure the decisions with nested all or any combination as mentioned below
+
+We will use the same rule file Employee-Salary created before for this section. 
+
+Previously, we have configured facts such as designation, type and experience to derive *salary* for just one designation **Manager** for simplicity. However, in real time, we might have other designation roles and facts to consider. Lets see a example below to understand much better
+
+For ex:
+
+We get new requirement to add *"Architect"* role with the same salary as *"Manager"* role. To handle this scenario, we can do either of the below 
+
+1. Create a new decision with same salary.
+
+    ![create new decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions1.png)
+
+2. Or You can modify the existing decision by nesting with **any** condition as below 
+
+    ![create another decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions2.png)
+
+
+First solution is same as we discussed before. Please refer [previous section](https://vinzdeveloper.github.io/json-rule-editor/docs/create-rules.html) incase any queries,
+
+Lets explore the second solution to understand how nested conditions can be created.
+
+*Step 1: Add new decision with two facts experience and type*
+
+![create nested decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions3.png)
+
+*Step 2: Select "Add Any" menu in **"Step 2: Add / Remove facts"** - you will get something as below*
+
+![create nested decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions4.png)
+
+*Step 3:  Click "any" node as highlighted below to add facts under this node*
+
+![create nested decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions5.png)
+
+*Step 4: Select "Add Facts" menu in **"Step 2: Add / Remove facts"** and click Add button*
+
+![create nested decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions6.png)
+
+**After added:**
+
+![create nested decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions7.png)
+
+*Step 5: Select "Add Facts" menu in **"Step 2: Add / Remove facts"** and click Add button to add another role "Architect"*
+
+![create nested decision](https://vinzdeveloper.github.io/json-rule-editor/docs/images/more-decisions8.png)
+
+*Step 6: Select "Add outcome" menu in **"Step 3: Add outcome"** and give value*
+
+*Step 7: Click Add rulecase button*
+
+That's it!!!
+
+Likewise, you can add any number of nested nodes under single conditions. Both solution 1 and solution 2 are doing same thing, depends on business requirement and number of facts, decide the pattern whichver it suits better.
+
+[Next section - Advanced examples](https://vinzdeveloper.github.io/json-rule-editor/docs/advanced.html)
+
+[Go back to previous page](https://vinzdeveloper.github.io/json-rule-editor/docs/manage-rules.html)
+
+[Go Home](https://vinzdeveloper.github.io/json-rule-editor/)
+
+
+