/kimbo.js

An ECMAScript 5 only-compatible JavaScript library.

Primary LanguageJavaScriptMIT LicenseMIT

An ECMAScript 5 only-compatible JavaScript library

The goal of this light-weight JavaScript library is to provide a nice, shorter and extended API using latest native compliant JavaScript and DOM APIs. Taking advantage of amazing native speed, of course only in modern browsers, and no more adding extra bytes for older ones.

Give it a try and start using a robust, light-weight and modern library today.

API Documentation

Please visit the documentation to see how easy is to use with its jQuery compatible API.

Build

In order to run the build task you'll need NodeJS and Grunt.js.

After installing NodeJS, clone the project by running:

$ git clone git://github.com/dciccale/kimbo.js.git

Install grunt-cli:

$ npm install -g grunt-cli

Enter kimbo.js directory and install local dependencies:

$ cd kimbo.js && npm install

Now to run the full build task just run:

$ grunt

A dist/ folder will be created containing development and production build of kimbo.js including a source map file.

Running the Unit Tests

Run grunt coffee task to compile .coffee spec files:

$ grunt coffee

And then open test/SpecRunner.html in your browser.

Current status

The current version is the first release that even it works pritty well, is still under heavy development. For now there isn't a browser compatibility table but have in mind it is intended for (and working) in modern mobile and desktop browsers.

Next steps

  • Unit tests (in progress)
  • Gestures module
  • Touch events module
  • XHR2 APIs

Follow @kimbojs on twitter to get the latest news.

Author

Denis Ciccale (@tdecs)

Thanks to Gonzalo Redondo Portero for making the logo

License

See LICENSE.txt