Converted readme to markdown, added some function reference
This commit is contained in:
parent
6ecc805fd2
commit
ccf8e04b8b
5
README
5
README
@ -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
|
44
README.md
Normal file
44
README.md
Normal file
@ -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);`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user