File tree Expand file tree Collapse file tree 3 files changed +44
-45
lines changed Expand file tree Collapse file tree 3 files changed +44
-45
lines changed Original file line number Diff line number Diff line change 1
- Boilerplate Generator Template
2
- ========================================
1
+ # jQuery generator
3
2
4
- A simple Yeoman generator using Git submodules to clone over a boilerplate hosted elsewhere on GitHub .
3
+ > A Yeoman generator that provides a functional boilerplate to easily create jQuery plugins out of the box .
5
4
6
- Getting started
7
- ---------------
5
+ Maintainer: [ Zeno Rocha] ( https://github.com/zenorocha )
8
6
9
- These are a few things you will want to customize:
7
+ ## Usage
10
8
11
- 1 . ` git submodule add YOUR-REPO-ON-GITHUB app/templates `
12
- 2 . README.md: Anywhere you see 'boilerplate' should be customized with the name of the generator you are creating (e.g generator-awesome)
13
- 3 . package.json: Customize the repository, author and dependencies.
9
+ 1 . Install [ Yeoman] ( https://github.com/yeoman/yo ) : ` [sudo] npm install -g yo `
10
+ 2 . Install the generator: ` [sudo] npm install -g generator-jquery `
11
+ 3 . Run: ` yo jquery `
12
+ 4 . Start writing your jQuery plugin :)
14
13
15
- You can then test out your generator without pushing to npm using ` npm install -g ` and
16
- ` yo awesome ` (where awesome is the name of your generator).
14
+ ## History
17
15
18
- Usage (for your end-users)
19
- ---------------
16
+ * v0.0.1 May 10, 2013
17
+ * Clone @addyosmani's [Generator Boilerplate](https://github.com/addyosmani/generator-boilerplate)
20
18
21
- 1 . Install Yeoman: ` npm install -g yo `
22
- 2 . Install the generator locally: ` npm install -g generator-boilerplate `
23
- 3 . Run: ` yo boilerplate `
24
- 4 . Start using Boilerplate
19
+ ## License
25
20
21
+ [ MIT License] ( http://zenorocha.mit-license.org/ )
Original file line number Diff line number Diff line change @@ -21,7 +21,7 @@ var Generator = module.exports = function() {
21
21
22
22
this . package = JSON . parse ( this . readFileAsString ( path . join ( __dirname , '../package.json' ) ) ) ;
23
23
24
- this . log . writeln ( 'Generating from ' + 'Generator Boilerplate ' . cyan + ' v' + this . package . version . cyan + '...' ) ;
24
+ this . log . writeln ( 'Generating from ' + 'Generator jQuery ' . cyan + ' v' + this . package . version . cyan + '...' ) ;
25
25
26
26
files . forEach ( function ( file ) {
27
27
if ( ignores . indexOf ( file ) !== - 1 ) {
@@ -32,4 +32,4 @@ var Generator = module.exports = function() {
32
32
} , this ) ;
33
33
} ;
34
34
35
- Generator . name = "Generator Boilerplate " ;
35
+ Generator . name = "Generator jQuery " ;
Original file line number Diff line number Diff line change 1
1
{
2
- "name" : " generator-boilerplate" ,
3
- "version" : " 0.1.4" ,
4
- "description" : " Yeoman Generator for ..." ,
5
- "main" : " app/index.js" ,
6
- "repository" : {
7
- "type" : " git" ,
8
- "url" : " git://github.com/addyosmani/generator-boilerplate.git"
9
- },
10
- "keywords" : [
11
- " yeoman-generator"
12
- ],
13
- "author" : {
14
- "name" : " Addy Osmani" ,
15
-
16
- },
17
- "engines" : {
18
- "node" : " >=0.8.0"
19
- },
20
- "license" : [
21
- {
22
- "type" : " MIT"
23
- }
24
- ],
25
- "dependencies" : {
26
- "yeoman-generator" : " ~0.10.2"
27
- }
2
+ "name" : " generator-jquery" ,
3
+ "version" : " 0.0.1" ,
4
+ "description" : " Yeoman Generator for jQuery Boilerplate" ,
5
+ "main" : " app/index.js" ,
6
+ "repository" : {
7
+ "type" : " git" ,
8
+ "url" : " git://github.com/zenorocha/generator-jquery.git"
9
+ },
10
+ "keywords" : [
11
+ " jquery" ,
12
+ " jquery-boilerplate" ,
13
+ " jquery-plugins" ,
14
+ " yeoman-jquery"
15
+ ],
16
+ "author" : {
17
+ "name" : " Zeno Rocha" ,
18
+
19
+ },
20
+ "engines" : {
21
+ "node" : " >=0.8.0"
22
+ },
23
+ "license" : [
24
+ {
25
+ "type" : " MIT"
26
+ }
27
+ ],
28
+ "dependencies" : {
29
+ "yeoman-generator" : " ~0.10.2"
30
+ }
28
31
}
You can’t perform that action at this time.
0 commit comments