-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
50 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |