10
10
[ ![ Dependency Status] ( https://img.shields.io/gemnasium/makenew/coffeescript-package.svg )] ( https://gemnasium.com/makenew/coffeescript-package )
11
11
[ ![ Build Status] ( https://img.shields.io/travis/makenew/coffeescript-package.svg )] ( https://travis-ci.org/makenew/coffeescript-package )
12
12
13
- Use this project freely as a base for your [ CoffeeScript] packages.
14
-
15
- [ CoffeeScript ] : http://coffeescript.org/
16
-
17
13
## Description
18
14
15
+ Bootstrap a new [ CoffeeScript] package in less than five minutes.
16
+
19
17
### Features
20
18
21
- * [ Bower] package structure.
19
+ * [ Bower] and [ npm ] package structure.
22
20
* [ Grunt] tasks for development.
23
- * Node package management with [ npm] .
24
21
* [ Travis CI] ready.
25
22
* [ EditorConfig] .
26
- * Badges from [ Shields.io] !
23
+ * Badges from [ Shields.io] .
27
24
25
+ [ CoffeeScript ] : http://coffeescript.org/
28
26
[ EditorConfig ] : http://editorconfig.org/
29
27
[ Grunt ] : http://gruntjs.com/
30
28
[ npm ] : https://www.npmjs.com/
@@ -96,7 +94,13 @@ $ git merge upstream/master
96
94
## Installation
97
95
98
96
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
100
104
101
105
```
102
106
$ bower install --save coffeescript-package
@@ -105,42 +109,55 @@ $ bower install --save coffeescript-package
105
109
Alternatively, you can download a [ release] [ Releases ]
106
110
or clone the repository directly.
107
111
112
+ [ Bower ] : http://bower.io/
113
+ [ npm ] : https://www.npmjs.com/
114
+ [ Releases ] : https://github.com/makenew/coffeescript-package/releases
115
+
108
116
## Development and Testing
109
117
110
118
### Source Code
111
119
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.
114
121
To clone the project run
115
122
116
123
```
117
124
$ git clone https://github.com/makenew/coffeescript-package.git
118
125
```
119
126
127
+ [ coffeescript-package source ] : https://github.com/makenew/coffeescript-package
128
+
120
129
### Requirements
121
130
122
- You will need [ npm ] with [ Grunt ] and [ Bower ] .
131
+ You will need [ Node.js ] with [ npm ] .
123
132
124
133
Install the development dependencies with
125
134
126
135
```
127
136
$ npm install
128
- $ bower install
129
137
```
130
138
139
+ [ Node.js ] : https://nodejs.org/
140
+
131
141
### Grunt
132
142
133
- Run ` grunt --help ` to see all Grunt tasks.
143
+ Optionally, you may run addtional development tasks with [ Grunt] .
144
+ Install it with
134
145
135
146
```
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.
139
158
```
140
159
141
- [ Bower ] : http://bower.io/
142
160
[ Grunt ] : http://gruntjs.com/
143
- [ npm ] : https://www.npmjs.com/
144
161
145
162
## Contributing
146
163
0 commit comments