Added a better README
This commit is contained in:
parent
48038c4aee
commit
d3462121e0
25
README.md
25
README.md
@ -3,7 +3,24 @@
|
||||
> Share frontend assets between different CartoDB repositories
|
||||
|
||||
|
||||
- CSS styleguide.
|
||||
- JS styleguide.
|
||||
- CSS components.
|
||||
- Font icon?
|
||||
### Installation
|
||||
As easy as:
|
||||
- ```npm install```
|
||||
|
||||
### 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```
|
||||
|
||||
### Publish a new version
|
||||
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).
|
||||
|
||||
If you have previous steps done:
|
||||
|
||||
- ```npm publish```
|
||||
|
Loading…
Reference in New Issue
Block a user