Clarified the Install/Usage steps.

serbanghita · Apr 6, 2018 · 19363b7 · 19363b7
1 parent 4636a87
commit 19363b7
Showing 1 changed file with 48 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -8,54 +8,54 @@
 > Convert **HTML forms** with all their **fields** and **values** to **multi-dimensional JavaScript** objects
 
 
-##### How to use
- > Supports Traditional, RequireJS / AWD and CommonJS / Browserfy style imports.
-
-```html
-<!-- Include minified script (~2kb) -->
-<script src="build/formToObject.min.js"></script>
-```
-
-
-**Using the DOM node id**
-
-```javascript
-var myFormObj = formToObject('myFormId');
-/* 
-  console.log(myFormObj);
-  {
-    saveSettings: 'Save',
-    name: 'Serban',
-    race: 'orc',
-    settings: {
-       input: 'keyboard',
-       video: {
-          resolution: '1024x768',
-          vsync: 'on'
-       }
-    }
-  }
-*/
-```
-
-**Using the actual DOM Node**
-
-```javascript
-var $formNode = document.getElementById('myFormId');
-var myFormObj = formToObject($formNode);
-console.log(myFormObj);
-```
-
-Sending form data server-side
-
-```javascript
-$.ajax({
-  'url': '/app/settings/save/',
-  'type': 'post',
-  'data': formToObject('saveSettingsForm'),
-  'success': function(r){}
-});
-```
+## Install
+
+**Node.js**
+
+* `npm install form_to_object`
+
+**Browser**
+
+    <!-- Include minified script (~2kb) -->
+    <script src="dist/formToObject.min.js"></script>
+
+
+## Usage
+
+> Using the DOM node id.
+
+
+    var result = formToObject('myFormId');
+    /* 
+      console.log(result);
+      {
+        saveSettings: 'Save',
+        name: 'Serban',
+        race: 'orc',
+        settings: {
+           input: 'keyboard',
+           video: {
+              resolution: '1024x768',
+              vsync: 'on'
+           }
+        }
+      }
+    */
+
+
+> Using the actual DOM Node reference.
+
+    formToObject(document.getElementById('myFormId'));
+
+
+> XHR - sending form data
+
+    $.ajax({
+      'url': '/app/settings/save/',
+      'type': 'post',
+      'data': formToObject('saveSettingsForm'),
+      'success': function(r){}
+    });
 
 ##### Browser support