Update README.md

documentation
master
Steve L. Nyemba 9 years ago
parent 34ff3e6721
commit 87189f2f9f

@ -7,18 +7,23 @@ The simple Javascript eXtension framework (jx in short) implements wrappers arou
<tr style="font-weight:bold; text-transform:capitalize" valign="center"><td> <tr style="font-weight:bold; text-transform:capitalize" valign="center"><td>
dom.js dom.js
</td> </td>
<td>utils.js</td>
<td>rpc.js</td> <td>rpc.js</td>
</tr> </tr>
<tr style="font-size:11px"> <tr style="font-size:11px">
<td> <td>
This file is intended to handle DOM objects via <b>jx.dom</b> namespace. The namespace will rely on DOM object identifiers (ID) with a few exceptions of radio & checkboxes. The handling is mostly around getting and setting data on various attributes. This file is intended to handle DOM objects via <b>jx.dom</b> namespace. The namespace will rely on DOM object identifiers (ID) with a few exceptions of radio & checkboxes. The handling is mostly around getting and setting data on various attributes.
The focus of a dom object is mostly centered around a single DOM object, <br>
We advise using utils.js in order to handle collections of DOM objects as utils.js implements various utilities and industry standard design patterns We advise using utils.js in order to handle collections of DOM objects as utils.js implements various utilities and industry standard design patterns
<br>
This implementation is designed by W3C specifications of HTML5 and will integrate well with other frameworks that do so. 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 In addition we tried to mildly specify preconditions for executions of functions
</td> </td>
<td>
This file implements common utilities for managing JSON objects and collections. We have implemented the handling of collections around some well known design patterns, iterator, visitor and observer. We have chosen these considering the scope & context in which javascript is used. That being said they can be extended & optimized. They come in handy when handling collections of DOM objects (for example search, setting values on attributes)
</td>
<td> <td>
This file is designed to handle http requests post, get, put of data and submitting form data as well. This file is designed to handle http requests post, get, put of data and submitting form data as well.

Loading…
Cancel
Save