Skip to content

Commit 3f784ce

Browse files
author
Ben Ilegbodu
committed
chore(docs): Fix errors in main README
1 parent a4e1dd7 commit 3f784ce

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,22 @@
2020

2121
A highly-opinionated, zero-config CLI for consistent infra for Ben Ilegbodu's Typescript-based libraries.
2222

23-
## ToC
24-
25-
- [Installation](#installation)
26-
- [Quick Usage](#quick-usage)
27-
- [Docs](docs/)
28-
- [Supported Node Versions](#supported-node-versions)
29-
- [Technologies Used](#technologies-used)
30-
- [Contributing](CONTRIBUTING.md)
31-
- [Project philosophy](#project-philosophy)
32-
- [License](LICENSE)
23+
## Table of Contents
24+
25+
- [@benmvp/cli](#benmvpcli)
26+
- [Table of Contents](#table-of-contents)
27+
- [Installation](#installation)
28+
- [Quick Usage](#quick-usage)
29+
- [Unit Testing](#unit-testing)
30+
- [Developing](#developing)
31+
- [Building](#building)
32+
- [Integration Testing](#integration-testing)
33+
- [Docs](#docs)
34+
- [Supported Node Versions](#supported-node-versions)
35+
- [Technologies Used](#technologies-used)
36+
- [Contributing](#contributing)
37+
- [Project philosophy](#project-philosophy)
38+
- [License](#license)
3339

3440
## Installation
3541

@@ -45,11 +51,14 @@ Installs the latest version of `@benmvp/cli` as a dev dependency and updates the
4551
"scripts": {
4652
"start": "benmvp start",
4753
"test": "benmvp test",
48-
"build": "benmvp build"
54+
"build": "benmvp build",
55+
"integrate": "benmvp integrate"
4956
}
5057
}
5158
```
5259

60+
> NOTE: More fields within the `package.json` will be updated to set up the library for proper releasing.
61+
5362
Read the API docs for more on [`benmvp create`](docs/cli/create.md).
5463

5564
## Quick Usage
@@ -118,7 +127,7 @@ Contributions are welcome! See [Contributing Guidelines](CONTRIBUTING.md) for mo
118127

119128
## Project philosophy
120129

121-
We take the stability of this SDK **very** seriously. `@benmvp/cli` follows the [SemVer](http://semver.org/) standard for versioning.
130+
We take the stability of this library **very** seriously. `@benmvp/cli` follows the [SemVer](http://semver.org/) standard for versioning.
122131

123132
All updates must pass the [CI build](https://github.com/benmvp/benmvp-cli/actions).
124133

0 commit comments

Comments
 (0)