documentation update

10 years ago · fc8f951669
parent 3a42b7c96e
commit fc8f951669
2 changed files with 26 additions and 22 deletions
--- a/README.md
+++ b/README.md
@ -3,13 +3,16 @@ Simple Javascript eXtension Framework

 The simple Javascript eXtension framework (jx in short) implements wrappers around common tasks performed on DOM object, JSON object and implements various utilities like design patterns for easy handling of collections as well as mathematic functions and some basic machine learning techniques and models. Jx doesn't get in the way of other frameworks like jQuery; Dojo; Mootools; Backbone; Boostrap. We put in a conerted effort to keep it simple.  

+<b>dom.js</b>:
+Handling of DOM objects will rely on DOM object identifiers (ID) with a few exceptions. 
+The focus of a dom object is mostly centered around a single DOM object, 

-dom.js: Handles common tasks around a dom object with a simple interface
-Example:
-<html>
-    <select id="dropdown">
-        <option value="one" selected>First Option</option>
-        <option value="two">First Option</option>
-    </select>    
-</html>
-value = jx.dom.get.value('dropdown')
+We advise using utils.js in order to handle collections of DOM objects as utils.js implements various utilities and industry standard design patterns 
+ 
+This implementation is designed by W3C specifications of HTML5 and will integrate well with other frameworks that do so.
+-- In addition we tried to mildly specify preconditions for executions of functions
+
+<b>rpc.js</b>: 
+<b>utils.js</b>:
+<b>ext/math.js</b>:
+<b>ext/ml.js</b>:
--- a/dom.js
+++ b/dom.js
@ -1,17 +1,18 @@
 /**
- * Javascript-x framework version 1.0, 
- * (c) 2012 - 2014, The Phi Technology LLC, https://the-phi.com
- * Steve L. Nyemba <steve@the-phi.com>
- * 
- * Handling of DOM objects will rely on DOM object identifiers (ID) with a few exceptions. 
- * The focus of a dom object is mostly centered around a single DOM object, 
- * We advise using utils.js in order to handle collections of DOM objects as utils.js implements various utilities and industry standard design patterns 
- * 
- * This implementation is designed by W3C specifications of HTML5 and will integrate well with other frameworks that do so.
- * In addition we tried to mildly specify preconditions for executions of functions
- *
- * LICENSE: GPLv3:
- *  This program comes with absolute NO WARRANTY or implied warranty and is free to use for any purpose: modified, integrated, distributed at will.
+* Simple Javascript eXtension - 1.0
+* (c) 2011 - 2015 Steve L. Nyemba, steve@the-phi.com
+* License GPL version 3.0
+* 
+* 
+* Handling of DOM objects will rely on DOM object identifiers (ID) with a few exceptions. 
+* The focus of a dom object is mostly centered around a single DOM object, 
+* We advise using utils.js in order to handle collections of DOM objects as utils.js implements various utilities and industry standard design patterns 
+* 
+* This implementation is designed by W3C specifications of HTML5 and will integrate well with other frameworks that do so.
+* In addition we tried to mildly specify preconditions for executions of functions
+*
+* LICENSE: GPLv3:
+*  This program comes with absolute NO WARRANTY or implied warranty and is free to use for any purpose: modified, integrated, distributed at will.
 */

 if(!jx){