CartoAssets/README.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2016-01-15 02:29:08 +08:00
# CartoAssets [![NPM version](http://img.shields.io/npm/v/cartoassets.svg)](https://www.npmjs.org/package/cartoassets)
2016-01-14 19:14:43 +08:00
> Share frontend assets between different CartoDB repositories
2016-01-15 02:23:36 +08:00
### Installation
As easy as:
- ```npm install```
2016-01-15 20:21:22 +08:00
- ```npm install -g markdown-styleguide-generator``` [StyleGenerator installation](https://www.npmjs.com/package/markdown-styleguide-generator#install)
2016-01-15 02:23:36 +08:00
### Build
If you want to use any of the CartoAssets components, after the installation just run:
- ```grunt build```
### Development
It will generate a UI documentation about the components in this repository:
- ```grunt dev```
2016-01-15 20:22:02 +08:00
If you want to check the documenation, it is generated in the ```dist``` folder.
2016-01-15 20:21:22 +08:00
2016-01-15 05:17:06 +08:00
### Publish a new version in NPM
2016-01-15 02:23:36 +08:00
In order to publish a new version of CartoAssets you need to:
- Change version of the package.
- Be a collaborator of the [npm module](https://www.npmjs.com/cartoassets) (Send an email to xavijam[at]cartodb.com).
2016-01-15 04:42:55 +08:00
If you have these previous steps done:
2016-01-15 02:23:36 +08:00
- ```npm publish```
2016-01-15 05:17:06 +08:00
### Publish CartoAssets styleguide and documentation in GH-Pages
Just run this command:
- ```grunt publish```