Skip to content

Commit

Permalink
Pimp the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Arian Stolwijk committed Oct 23, 2011
1 parent fbfbd80 commit fa429a2
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Expand Up @@ -5,14 +5,14 @@ Milk.js is the new super modular JavaScript framework and is a MooTools project.

Milk.js consist out of:

- Base
- DOM
- Slick
- Request
- Fx
- JSON
- Color
- Table
- *Base* - Base functionality, Array, Function, String, Number and Object methods, Class and other goodies
- *DOM* - A OOP based DOM API with Class as Element wrappers.
- *Slick* - Our super duper famous and precise selector engine.
- *Request* - Everything you requests. Especially a XHR wrapper, but also JSONP.
- *Fx* - Shiny Animations
- *JSON* - JSON decoding and encoding
- *Color* - Convert your HEX codes to rgb values, other transformations, a colorfull package.
- *Table* - Actually a Map, but can store values with non scalar keys.

Use the [issues](https://github.com/mootools/Milk/issues) for any Milk.js project
related issues. For package specific issues please create a new issue there.
Expand All @@ -23,3 +23,9 @@ AMD
All these cool packages will use [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD), the new relatively and awesome module format.

If you're brave enough to test some features you will need a AMD loader like [require.js](http://requirejs.org/).


Testing
-------

Testing will be done with our test suite *Sprinter*. Soon, in the near future, each repository will have a `Spec` folder containing all the specs for that project. Sprinter uses [Jasmine](https://github.com/pivotal/jasmine/wiki) and (usually) Require.JS.

0 comments on commit fa429a2

Please sign in to comment.