You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .verb.md
+33-8Lines changed: 33 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,24 @@
4
4
5
5
Toolkit is a suite of open-source developer tools for initializing, configuring, building, documenting and maintaining code projects.
6
6
7
-
All of the applications in the toolkit suite are completely standalone and can be used without knowledge of the other applications. However, all of the applications share the same core API, so by learning any one of the applications, you will know how to begin using all of them.
7
+
## Why should I use toolkit?
8
+
9
+
**Highly decoupled, consistent API**
10
+
11
+
All of the applications in the toolkit suite are completely standalone and can be used without knowledge of the other applications. This means you can pick and choose which applications, tools or frameworks you want to use.
12
+
13
+
**Learn one, learn them all**
14
+
15
+
Moreover, all of the applications share the same core API, so by learning any one of the applications, you will know how to begin using all of them.
16
+
17
+
**Create applications**
18
+
19
+
Whether you're creating a web server with [express][] or [koa][], a web application using [react][], [ember][] or [angular][], or your own build system, toolkit has frameworks and tools that can be used to expedite the process.
8
20
9
21
Visit toolkit.io (coming soon) for more information.
10
22
11
-
## Suite
23
+
24
+
## What does toolkit do?
12
25
13
26
Tookit applications are organized into the following categories:
14
27
@@ -19,13 +32,16 @@ Tookit applications are organized into the following categories:
19
32
20
33
### Building blocks
21
34
35
+
Create an "instant API" for your node.js application. These "building blocks" are used as
36
+
22
37
*[base][]: Bare-bones starting point for creating a high quality node.js application. Build out your API by using plugins like building blocks. All of other the applications in the toolkit suite were created using Base.
23
38
*[templates][]: System for creating and managing template collections, and rendering templates with any node.js template engine. Can be used as the basis for creating a static site generator, blog framework, documentaton system, and so on.
24
39
25
-
26
40
### Lifecycle
27
41
28
-
Developer frameworks and command line tools for major aspects of the software development lifecycle:
42
+
Developer frameworks and command line tools that address common phases of the software development lifecycle. Each of these tools can be used standalone, but they work even better together.
43
+
44
+
**Tools**
29
45
30
46
1.[generate][]: create projects
31
47
1.[assemble][]: build projects
@@ -35,8 +51,17 @@ Developer frameworks and command line tools for major aspects of the software de
35
51
36
52
### Configuration
37
53
38
-
Tools and conventions for defining and using portable, re-usable, declarative configurations.
54
+
Tools and conventions for defining, using and publishing declarative configurations for projects, components and templates.
55
+
56
+
**Tools**
57
+
58
+
*[boilerplate][]: Describes all of the necessary files, templates and settings required to initialize a complete, new project.
59
+
*[scaffold][]: Describes all of the necessary files, templates and settings required to initialize a complete, new project.
60
+
*[snippet][]: Tools and conventions for creating, using and publishing invidual snippets of code or text.
61
+
62
+
**Advantages**
63
+
64
+
By keeping a separation of concerns between configuration and everything else (application logic, flow control, etc), we can use plain, generic javascript, with prescriptive conventions to describe commonly needed objects, files, templates, and assets.
65
+
66
+
As a result, projects are lower complexity, easier to maintain, and the objects can be passed around to any rendering engine, build system or project generator when its time to create something.
Copy file name to clipboardExpand all lines: README.md
+34-10Lines changed: 34 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,23 @@
4
4
5
5
Toolkit is a suite of open-source developer tools for initializing, configuring, building, documenting and maintaining code projects.
6
6
7
-
All of the applications in the toolkit suite are completely standalone and can be used without knowledge of the other applications. However, all of the applications share the same core API, so by learning any one of the applications, you will know how to begin using all of them.
7
+
## Why should I use toolkit?
8
+
9
+
**Highly decoupled, consistent API**
10
+
11
+
All of the applications in the toolkit suite are completely standalone and can be used without knowledge of the other applications. This means you can pick and choose which applications, tools or frameworks you want to use.
12
+
13
+
**Learn one, learn them all**
14
+
15
+
Moreover, all of the applications share the same core API, so by learning any one of the applications, you will know how to begin using all of them.
16
+
17
+
**Create applications**
18
+
19
+
Whether you're creating a web server with [express](http://expressjs.com/) or [koa](https://github.com/koajs/koa), a web application using [react](https://facebook.github.io/react/), [ember](http://github.com/emberjs/ember.js) or [angular](http://angularjs.org), or your own build system, toolkit has frameworks and tools that can be used to expedite the process.
8
20
9
21
Visit toolkit.io (coming soon) for more information.
10
22
11
-
## Suite
23
+
## What does toolkit do?
12
24
13
25
Tookit applications are organized into the following categories:
14
26
@@ -18,12 +30,16 @@ Tookit applications are organized into the following categories:
18
30
19
31
### Building blocks
20
32
33
+
Create an "instant API" for your node.js application. These "building blocks" are used as
34
+
21
35
*[base](https://github.com/node-base/base): Bare-bones starting point for creating a high quality node.js application. Build out your API by using plugins like building blocks. All of other the applications in the toolkit suite were created using Base.
22
36
*[templates](https://github.com/jonschlinkert/templates): System for creating and managing template collections, and rendering templates with any node.js template engine. Can be used as the basis for creating a static site generator, blog framework, documentaton system, and so on.
23
37
24
38
### Lifecycle
25
39
26
-
Developer frameworks and command line tools for major aspects of the software development lifecycle:
40
+
Developer frameworks and command line tools that address common phases of the software development lifecycle. Each of these tools can be used standalone, but they work even better together.
@@ -32,11 +48,19 @@ Developer frameworks and command line tools for major aspects of the software de
32
48
33
49
### Configuration
34
50
35
-
Tools and conventions for defining and using portable, re-usable, declarative configurations.
51
+
Tools and conventions for defining, using and publishing declarative configurations for projects, components and templates.
52
+
53
+
**Tools**
54
+
55
+
*[boilerplate](https://github.com/jonschlinkert/boilerplate): Describes all of the necessary files, templates and settings required to initialize a complete, new project.
56
+
*[scaffold](https://github.com/jonschlinkert/scaffold): Describes all of the necessary files, templates and settings required to initialize a complete, new project.
57
+
*[snippet](https://github.com/jonschlinkert/snippet): Tools and conventions for creating, using and publishing invidual snippets of code or text.
58
+
59
+
**Advantages**
60
+
61
+
By keeping a separation of concerns between configuration and everything else (application logic, flow control, etc), we can use plain, generic javascript, with prescriptive conventions to describe commonly needed objects, files, templates, and assets.
As a result, projects are lower complexity, easier to maintain, and the objects can be passed around to any rendering engine, build system or project generator when its time to create something.
40
64
41
65
## Author
42
66
@@ -47,9 +71,9 @@ Tools and conventions for defining and using portable, re-usable, declarative co
0 commit comments