Skip to content
This repository was archived by the owner on Dec 14, 2018. It is now read-only.

Commit ab932e1

Browse files
committed
Add npm badge and improve README
1 parent 94cfe0d commit ab932e1

File tree

1 file changed

+44
-15
lines changed

1 file changed

+44
-15
lines changed

README.md

+44-15
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# libSass Package Skeleton
22

33
<!--
4-
[![Bower Version](https://img.shields.io/bower/v/libsass-package.svg)](http://bower.io/search/?q=libsass-package)
4+
[![npm](https://img.shields.io/npm/v/makenew-libsass-package.svg)](https://www.npmjs.com/package/makenew-libsass-package)
55
-->
6-
[![MIT License](https://img.shields.io/github/license/makenew/libsass-package.svg)](./LICENSE.txt)
6+
<!--
7+
[![Bower](https://img.shields.io/bower/v/makenew-libsass-package.svg)](http://bower.io/search/?q=makenew-libsass-package)
8+
-->
9+
[![GitHub license](https://img.shields.io/github/license/makenew/libsass-package.svg)](./LICENSE.txt)
710
[![Dependency Status](https://img.shields.io/gemnasium/makenew/libsass-package.svg)](https://gemnasium.com/makenew/libsass-package)
8-
[![Build Status](https://img.shields.io/travis/makenew/libsass-package/libsass.svg)](https://travis-ci.org/makenew/libsass-package)
11+
[![Build Status](https://img.shields.io/travis/makenew/libsass-package.svg)](https://travis-ci.org/makenew/libsass-package)
912

1013
## Description
1114

@@ -99,51 +102,77 @@ $ git merge upstream/libsass
99102
## Installation
100103

101104
The recommended method is to add this as a dependency
102-
to your project using [Bower] with
105+
to your project using [npm] with
106+
107+
```
108+
$ npm install --save makenew-libsass-package
109+
```
110+
111+
or [Bower] with
103112

104113
```
105-
$ bower install --save libsass-package
114+
$ bower install --save makenew-libsass-package
106115
```
107116

108117
Alternatively, you can download a [release][Releases]
109118
or clone the repository directly.
110119

120+
[Bower]: http://bower.io/
121+
[npm]: https://www.npmjs.com/
122+
[Releases]: https://github.com/makenew/libsass-package/releases
123+
111124
## Development and Testing
112125

113126
### Source Code
114127

115-
The [libsass-package source](https://github.com/makenew/libsass-package)
116-
is hosted on GitHub.
128+
The [makenew-libsass-package source] is hosted on GitHub.
117129
To clone the project run
118130

119131
```
120132
$ git clone https://github.com/makenew/libsass-package.git
121133
```
122134

135+
[makenew-libsass-package source]: https://github.com/makenew/libsass-package
136+
123137
### Requirements
124138

125-
You will need [npm] with [Grunt] and [Bower].
139+
You will need [Node.js] with [npm].
126140

127141
Install the development dependencies with
128142

129143
```
130144
$ npm install
131-
$ bower install
145+
```
146+
147+
[Node.js]: https://nodejs.org/
148+
149+
### Build
150+
151+
Install any Bower dependencies and execute the default build task with
152+
153+
```
154+
$ npm start
132155
```
133156

134157
### Grunt
135158

136-
Run `grunt --help` to see all Grunt tasks.
159+
Optionally, you may run additional development tasks with [Grunt].
160+
Install it with
137161

138162
```
139-
grunt sass # Compile Sass to CSS
140-
grunt clean # Remove build directory
141-
grunt watch # Have Grunt watch for changes
163+
$ npm install --global grunt-cli
164+
```
165+
166+
Run `$ grunt --help` to see all Grunt tasks.
167+
168+
```
169+
clean # Clean files and folders. *
170+
watch # Run predefined tasks whenever watched files change.
171+
sass # Compile Sass to CSS *
172+
default # Alias for "clean", "sass" tasks.
142173
```
143174

144-
[Bower]: http://bower.io/
145175
[Grunt]: http://gruntjs.com/
146-
[npm]: https://www.npmjs.com/
147176

148177
## Contributing
149178

0 commit comments

Comments
 (0)