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

Commit bfeb856

Browse files
committed
Update to several README sections
1 parent 63d8621 commit bfeb856

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

README.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,19 @@
1010
[![Dependency Status](https://img.shields.io/gemnasium/makenew/coffeescript-package.svg)](https://gemnasium.com/makenew/coffeescript-package)
1111
[![Build Status](https://img.shields.io/travis/makenew/coffeescript-package.svg)](https://travis-ci.org/makenew/coffeescript-package)
1212

13-
Use this project freely as a base for your [CoffeeScript] packages.
14-
15-
[CoffeeScript]: http://coffeescript.org/
16-
1713
## Description
1814

15+
Bootstrap a new [CoffeeScript] package in less than five minutes.
16+
1917
### Features
2018

21-
* [Bower] package structure.
19+
* [Bower] and [npm] package structure.
2220
* [Grunt] tasks for development.
23-
* Node package management with [npm].
2421
* [Travis CI] ready.
2522
* [EditorConfig].
26-
* Badges from [Shields.io]!
23+
* Badges from [Shields.io].
2724

25+
[CoffeeScript]: http://coffeescript.org/
2826
[EditorConfig]: http://editorconfig.org/
2927
[Grunt]: http://gruntjs.com/
3028
[npm]: https://www.npmjs.com/
@@ -96,7 +94,13 @@ $ git merge upstream/master
9694
## Installation
9795

9896
The recommended method is to add this as a dependency
99-
to your project using [Bower] with
97+
to your project using [npm] with
98+
99+
```
100+
$ npm Install --save coffeescript-package
101+
```
102+
103+
or [Bower] with
100104

101105
```
102106
$ bower install --save coffeescript-package
@@ -105,42 +109,55 @@ $ bower install --save coffeescript-package
105109
Alternatively, you can download a [release][Releases]
106110
or clone the repository directly.
107111

112+
[Bower]: http://bower.io/
113+
[npm]: https://www.npmjs.com/
114+
[Releases]: https://github.com/makenew/coffeescript-package/releases
115+
108116
## Development and Testing
109117

110118
### Source Code
111119

112-
The [coffeescript-package source](https://github.com/makenew/coffeescript-package)
113-
is hosted on GitHub.
120+
The [coffeescript-package source] is hosted on GitHub.
114121
To clone the project run
115122

116123
```
117124
$ git clone https://github.com/makenew/coffeescript-package.git
118125
```
119126

127+
[coffeescript-package source]: https://github.com/makenew/coffeescript-package
128+
120129
### Requirements
121130

122-
You will need [npm] with [Grunt] and [Bower].
131+
You will need [Node.js] with [npm].
123132

124133
Install the development dependencies with
125134

126135
```
127136
$ npm install
128-
$ bower install
129137
```
130138

139+
[Node.js]: https://nodejs.org/
140+
131141
### Grunt
132142

133-
Run `grunt --help` to see all Grunt tasks.
143+
Optionally, you may run addtional development tasks with [Grunt].
144+
Install it with
134145

135146
```
136-
grunt coffee # Compile CoffeeScript to JavaScript
137-
grunt clean # Remove build directory
138-
grunt watch # Have Grunt watch for changes
147+
$ npm Install --global grunt-cli
148+
```
149+
150+
Run `$ grunt --help` to see all Grunt tasks.
151+
152+
```
153+
coffeelint # Validate files with CoffeeLint *
154+
clean # Clean files and folders. *
155+
coffee # Compile CoffeeScript files into JavaScript *
156+
watch # Run predefined tasks whenever watched files change.
157+
default # Alias for "clean", "coffeelint", "coffee" tasks.
139158
```
140159

141-
[Bower]: http://bower.io/
142160
[Grunt]: http://gruntjs.com/
143-
[npm]: https://www.npmjs.com/
144161

145162
## Contributing
146163

0 commit comments

Comments
 (0)