From 97c504e7e339972ff903e809bab453e11a003239 Mon Sep 17 00:00:00 2001 From: Ariel Mashraki Date: Tue, 7 Oct 2014 01:23:41 +0300 Subject: [PATCH] fix(README.md): expand readme --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2c45208..2a1a652 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ angular-local-storage ===================== -An Angular module that gives you access to the browsers local storage +An Angular module that gives you access to the browsers local storage, **v0.1.1** [![Build Status](https://secure.travis-ci.org/grevory/angular-local-storage.png?branch=master)](https://travis-ci.org/grevory/) -Installation: +##Installation: ```bash bower install angular-local-storage @@ -54,7 +54,26 @@ console.log(localStorageService.get('specialArtist')); Check out the full demo and documentation at http://gregpike.net/demos/angular-local-storage/demo.html -To do: -- Add tests +##TO DO: - Expand Readme +##Development: +Clone the project: +```bash +$ git clone https://github.com//angular-local-storage.git +$ npm install +$ bower install +``` +Run the tests: +```bash +$ grunt test +``` +**Deploy:**
+Run the build task, update version before(bower,package) +```bash +$ grunt build +$ git tag 0.*.* +$ git push origin master --tags +``` + +