Skip to content

Commit cfdd8f5

Browse files
committed
improve descriptions
1 parent 4eb44a1 commit cfdd8f5

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

.verb.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Getting started with toolkit
22

3+
> Toolkit makes humans scalable
4+
35
## What is toolkit?
46

57
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
1618

1719
**Create applications**
1820

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.
2222

23+
~~(coming soon) Visit toolkit.io for more information.~~
2324

2425
## What does toolkit do?
2526

@@ -30,10 +31,12 @@ Tookit applications are organized into the following categories:
3031
1. [lifecycle](#lifecycle)
3132
1. [automation](#automation)
3233

34+
_(Any of the tools in the `toolkit` suite may be used standalone, but they work even better together.)_
35+
3336

3437
### Building blocks
3538

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:
3740

3841
- [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.
3942
- [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
4346

4447
Tools and conventions for defining, using and publishing declarative configurations for projects, components and templates.
4548

46-
**Tools**
47-
4849
- [boilerplate][]: Describes all of the necessary files, templates and settings required to initialize a complete, new project.
4950
- [scaffold][]: Describes all of the necessary files, templates and settings required to initialize a complete, new project.
5051
- [snippet][]: Tools and conventions for creating, using and publishing invidual snippets of code or text.
5152

52-
**Synopsis**
53+
**Why is this useful?**
5354

5455
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_.
5556

@@ -58,9 +59,7 @@ As a result, projects are lower complexity, easier to maintain, and the objects
5859

5960
### Lifecycle
6061

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.
6463

6564
- [generate][]: scaffold out new projects
6665
- [assemble][]: build projects
@@ -69,6 +68,8 @@ Developer frameworks and command line tools that address common phases of the so
6968

7069
### Automation
7170

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+
7273
- [enquirer][]: Plugin-based prompt system, to automate interactions and conversations with users.
7374
- [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.

README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Getting started with toolkit
22

3+
> Toolkit makes humans scalable
4+
35
## What is toolkit?
46

57
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
1618

1719
**Create applications**
1820

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.
2022

21-
Visit toolkit.io (coming soon) for more information.
23+
~~(coming soon) Visit toolkit.io for more information.~~
2224

2325
## What does toolkit do?
2426

@@ -29,9 +31,11 @@ Tookit applications are organized into the following categories:
2931
3. [lifecycle](#lifecycle)
3032
4. [automation](#automation)
3133

34+
_(Any of the tools in the `toolkit` suite may be used standalone, but they work even better together.)_
35+
3236
### Building blocks
3337

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:
3539

3640
* [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.
3741
* [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
4044

4145
Tools and conventions for defining, using and publishing declarative configurations for projects, components and templates.
4246

43-
**Tools**
44-
4547
* [boilerplate](https://github.com/jonschlinkert/boilerplate): Describes all of the necessary files, templates and settings required to initialize a complete, new project.
4648
* [scaffold](https://github.com/jonschlinkert/scaffold): Describes all of the necessary files, templates and settings required to initialize a complete, new project.
4749
* [snippet](https://github.com/jonschlinkert/snippet): Tools and conventions for creating, using and publishing invidual snippets of code or text.
4850

49-
**Synopsis**
51+
**Why is this useful?**
5052

5153
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_.
5254

5355
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.
5456

5557
### Lifecycle
5658

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.
6060

6161
* [generate](https://github.com/generate/generate): scaffold out new projects
6262
* [assemble](https://github.com/assemble/assemble): build projects
6363
* [verb](https://github.com/verbose/verb): document projects
6464

6565
### Automation
6666

67+
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+
6769
* [enquirer](http://enquirer.io): Plugin-based prompt system, to automate interactions and conversations with users.
6870
* [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.
7072

7173
## Author
7274

0 commit comments

Comments
 (0)