From d3462121e04b00af348d46bed3670823be2750f2 Mon Sep 17 00:00:00 2001 From: xavijam Date: Thu, 14 Jan 2016 19:23:36 +0100 Subject: [PATCH] Added a better README --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1e6923c..8d962c1 100644 --- a/README.md +++ b/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```