From ccf8e04b8b3e020f0768f8a67609a3ebde6335d5 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Tue, 14 Jun 2011 12:48:24 -0400 Subject: [PATCH] Converted readme to markdown, added some function reference --- README | 5 ----- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 5 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 63ff94f..0000000 --- a/README +++ /dev/null @@ -1,5 +0,0 @@ -A Minimal, Modular Javascript library for Modern browsers. - -Aims to be fast, small, and easily split into individual modules. - -Browser support: IE8+, Latest versions of Firefox, Chrome, Safari, Opera diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b069a7 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Keep It Simple JS Library # + +A Minimal, Modular Javascript library for Modern browsers. + +Aims to be fast, small, and easily split into individual modules. + +Browser support: IE8+, Latest versions of Firefox, Chrome, Safari, Opera + +## Basic Use: ## + +* Selector: `var x = $(selector);` + +* Function: `$_.module.function(params);` + +## Modules: ## + +**Ajax**: simple, jQuery-like ajax functions + + functions: + + * Get: + Use: `$_.get(url, data_object, callback);` + + * Post: + Use: `$_.post(url, data_object, callback);` + +**QS**: querystring parsing and serialization for hashbang strings, and pushState urls + + functions: + + * Parse: + Use: `$_.qs.parse(hb);` + + * Set: This function will set the hash url if browser doesn't have history.pushState + Use: `$_.qs.set(key, value);` + + * Get: Retrieves the value of the key in the url string + Use: `$_.qs.get(key);` + + + + + +