From c7a22e326a0524f6db3b49ea5a7a17223d4c2d81 Mon Sep 17 00:00:00 2001 From: "Steve L. Nyemba" Date: Wed, 16 Dec 2015 09:48:28 -0500 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++------------------------- 1 file changed, 14 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 0a161fb..0616fe7 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,14 @@ 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. -dom.js: - + + + + + + + + +
+dom.js +rpc.js
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. The focus of a dom object is mostly centered around a single DOM object, @@ -12,28 +18,11 @@ We advise using utils.js in order to handle collections of DOM objects as utils. 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 - -rpc.js: + This file is designed to handle http requests post, get, put of data and submitting form data as well as uploading of files. The interface we have chosen is intended to be simple: -HttpClient.instance Creates an instance of an httpclient -httpclient.get(:url,:callback) - The object's member performs an http call with GET method and a callback method - -utils.js: - -Implementation of miscellaneous utilities commonly used, These functions are reusable and simple: -jx.utils.vector extracts a vector from an array of objects (or a matrix) -jx.utils.keys extract keys from an associative array -jx.utils.unique returns unique objects in an array, including array of objects (provided an key function) - -jx.utils.patterns: -Implementation of design patterns defined by the GOF http://en.wikipedia.org/wiki/Software_design_pattern - -jx.utils.patterns.visitor The visitor design pattern -jx.utils.patterns.iterator The iterator design pattern -jx.utils.patterns.observer The observer design pattern - -ext/math.js: - -ext/ml.js: +
+rpc.js: