From 0e7264da68b574c1818379074e7d7d60dd29234d Mon Sep 17 00:00:00 2001 From: "Steve L. Nyemba" Date: Thu, 5 Oct 2017 10:04:21 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 43 +++++++++++++++---------------------------- 1 file changed, 15 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index ac257da..1091eae 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,22 @@ 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 concerted effort to keep it simple yet useful. +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 plays well with existing frameworks like jQuery; Dojo; Mootools; Backbone; Boostrap. We put in a concerted effort to keep it simple yet useful. +
-dom.js -utils.jsrpc.js
+ + - - - - - + + -
ModulesDescription
-This file is intended to handle DOM objects via jx.dom 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. -
-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 -		 - 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) - -This file is designed to handle http requests post, get, put of data and submitting form data as well. - -HttpClient.instance is a factory class provided to access to the interface and provide the functionality - -
rpc.jsXMLHttpRequest wrapper. Enables to make ajax requests using a simple interface
-rpc.js: +dom.jsProvides an interfact to manipulate Document Object Model (DOM)... +utils.jsImplements reusable functions around design patterns to manipulate collections, JSON objects ... +ext/math.jsReusable mathematical and statistical functions +ext/ml.jsReusable big data framework with functions like map/reduce. + \ No newline at end of file