Skip to content

Commit

Permalink
Update README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
pazguille committed Dec 11, 2013
1 parent 935d583 commit d2759d1
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# Balloons JS
# balloons.js

An event-based JavaScript library to build front-end components or widgets.

## API
[WIP]

## Development setup
1. Install [Git](http://git-scm.com/) and [NodeJS](http://nodejs.org/).
2. Open your terminal and clone `balloonsjs/balloons` by running:

$ git clone [email protected]:balloonsjs/balloons.git

3. Now go to the project's folder:

$ cd balloons

4. Install its dependencies:

$ npm install

5. Install `grunt-cli`:

$ npm install grunt-cli -g

6. Run grunt tasks:

$ grunt

7. Develop! :)

**NOTE**

Please read through our code style guides:
- [HTML](https://github.com/mercadolibre/html-style-guide)
- [CSS](https://github.com/mercadolibre/css-style-guide)
- [JavaScript](https://github.com/mercadolibre/javascript-style-guide)

## Maintained by

- Her Mammana ([@hmammana](https://twitter.com/hmammana))
- Lean Linares ([@lean8086](https://twitter.com/lean8086))
- Guille Paz ([@pazguille](https://twitter.com/pazguille))

## Credits

![MercadoLibre](http://static.mlstatic.com/org-img/chico/img/logo-mercadolibre-new.png)

## License
Licensed under the MIT license.

Copyright (c) 2013 [MercadoLibre](http://github.com/mercadolibre).

0 comments on commit d2759d1

Please sign in to comment.