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
+12-11
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Getting started with toolkit
2
2
3
+
> Toolkit makes humans scalable
4
+
3
5
## What is toolkit?
4
6
5
7
Toolkit is a suite of open-source developer tools for initializing, configuring, building, documenting and maintaining code projects.
@@ -16,10 +18,9 @@ Moreover, all of the applications share the same core API, so by learning any on
16
18
17
19
**Create applications**
18
20
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.
20
-
21
-
Visit toolkit.io (coming soon) for more information.
21
+
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 tools that can be used to expedite the process.
22
22
23
+
~~(coming soon) Visit toolkit.io for more information.~~
23
24
24
25
## What does toolkit do?
25
26
@@ -30,10 +31,12 @@ Tookit applications are organized into the following categories:
30
31
1.[lifecycle](#lifecycle)
31
32
1.[automation](#automation)
32
33
34
+
_(Any of the tools in the `toolkit` suite may be used standalone, but they work even better together.)_
35
+
33
36
34
37
### Building blocks
35
38
36
-
Create an "instant API" for your node.js application. These "building blocks" are used as
39
+
These "building blocks" are used as as starting point, providing an "instant API" for your node.js application:
37
40
38
41
-[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.
39
42
-[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.
@@ -43,13 +46,11 @@ Create an "instant API" for your node.js application. These "building blocks" ar
43
46
44
47
Tools and conventions for defining, using and publishing declarative configurations for projects, components and templates.
45
48
46
-
**Tools**
47
-
48
49
-[boilerplate][]: Describes all of the necessary files, templates and settings required to initialize a complete, new project.
49
50
-[scaffold][]: Describes all of the necessary files, templates and settings required to initialize a complete, new project.
50
51
-[snippet][]: Tools and conventions for creating, using and publishing invidual snippets of code or text.
51
52
52
-
**Synopsis**
53
+
**Why is this useful?**
53
54
54
55
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_.
55
56
@@ -58,9 +59,7 @@ As a result, projects are lower complexity, easier to maintain, and the objects
58
59
59
60
### Lifecycle
60
61
61
-
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.
62
-
63
-
**Tools**
62
+
Developer frameworks and command line tools for common phases of the software development lifecycle.
64
63
65
64
-[generate][]: scaffold out new projects
66
65
-[assemble][]: build projects
@@ -69,6 +68,8 @@ Developer frameworks and command line tools that address common phases of the so
69
68
70
69
### Automation
71
70
71
+
These tools can be used during and throughout any point of the software development lifecycle to automate notifications, updates, and statuses, as well as conversions and interactions with users.
72
+
72
73
-[enquirer][]: Plugin-based prompt system, to automate interactions and conversations with users.
73
74
-[microbot][]: Empower your applications and users with automated responses, actions and notifications.
74
-
-[update][]: Automate updates for virtually any aspect of a project.
75
+
-[update][]: Automate boring and time consuming chores that are typically done manually, for virtually any aspect of a project.
Copy file name to clipboardExpand all lines: README.md
+12-10
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Getting started with toolkit
2
2
3
+
> Toolkit makes humans scalable
4
+
3
5
## What is toolkit?
4
6
5
7
Toolkit is a suite of open-source developer tools for initializing, configuring, building, documenting and maintaining code projects.
@@ -16,9 +18,9 @@ Moreover, all of the applications share the same core API, so by learning any on
16
18
17
19
**Create applications**
18
20
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](https://github.com/emberjs/ember) or [angular](http://angularjs.org), or your own build system, toolkit has frameworks and tools that can be used to expedite the process.
21
+
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](https://github.com/emberjs/ember) or [angular](http://angularjs.org), or your own build system, `toolkit` has tools that can be used to expedite the process.
20
22
21
-
Visit toolkit.io (coming soon) for more information.
23
+
~~(coming soon) Visit toolkit.io for more information.~~
22
24
23
25
## What does toolkit do?
24
26
@@ -29,9 +31,11 @@ Tookit applications are organized into the following categories:
29
31
3.[lifecycle](#lifecycle)
30
32
4.[automation](#automation)
31
33
34
+
_(Any of the tools in the `toolkit` suite may be used standalone, but they work even better together.)_
35
+
32
36
### Building blocks
33
37
34
-
Create an "instant API" for your node.js application. These "building blocks" are used as
38
+
These "building blocks" are used as as starting point, providing an "instant API" for your node.js application:
35
39
36
40
*[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.
37
41
*[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.
@@ -40,33 +44,31 @@ Create an "instant API" for your node.js application. These "building blocks" ar
40
44
41
45
Tools and conventions for defining, using and publishing declarative configurations for projects, components and templates.
42
46
43
-
**Tools**
44
-
45
47
*[boilerplate](https://github.com/jonschlinkert/boilerplate): Describes all of the necessary files, templates and settings required to initialize a complete, new project.
46
48
*[scaffold](https://github.com/jonschlinkert/scaffold): Describes all of the necessary files, templates and settings required to initialize a complete, new project.
47
49
*[snippet](https://github.com/jonschlinkert/snippet): Tools and conventions for creating, using and publishing invidual snippets of code or text.
48
50
49
-
**Synopsis**
51
+
**Why is this useful?**
50
52
51
53
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_.
52
54
53
55
As a result, projects are lower complexity, easier to maintain, and the objects can be passed around to any rendering engine, build system, scaffolding tool or project generator when its time to create or build something.
54
56
55
57
### Lifecycle
56
58
57
-
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.
58
-
59
-
**Tools**
59
+
Developer frameworks and command line tools for common phases of the software development lifecycle.
60
60
61
61
*[generate](https://github.com/generate/generate): scaffold out new projects
These tools can be used during and throughout any point of the software development lifecycle to automate notifications, updates, and statuses, as well as conversions and interactions with users.
68
+
67
69
*[enquirer](http://enquirer.io): Plugin-based prompt system, to automate interactions and conversations with users.
68
70
*[microbot](https://github.com/microbot/microbot): Empower your applications and users with automated responses, actions and notifications.
69
-
*[update](https://github.com/update/update): Automate updates for virtually any aspect of a project.
71
+
*[update](https://github.com/update/update): Automate boring and time consuming chores that are typically done manually, for virtually any aspect of a project.
0 commit comments