Skip to content

Commit 2cbb22c

Browse files
committed
docs: "what is this?"
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 6962882 commit 2cbb22c

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ A NestJS module for building CLI applications
2222

2323
## What is this?
2424

25-
**TODO**: package overview
25+
[NestJS][1] is a framework for building [Node.js][2] server-side applications. It can also be used, however, to build
26+
[standalone applications][3], thus allowing developers to implement the same architectural patterns across applications.
27+
Built on top of [Commander.js][4], `nest-commander` brings the NestJS developer experience to CLI applications.
2628

2729
## Install
2830

29-
This package is [ESM only][1].
31+
This package is [ESM only][5].
3032

3133
```sh
3234
yarn add -D @flex-development/nest-commander @nestjs/common @nestjs/core @nestjs/testing
@@ -51,11 +53,15 @@ yarn add -D @flex-development/nest-commander@flex-development/nest-commander @ne
5153

5254
## Types
5355

54-
This package is fully typed with [TypeScript][2].
56+
This package is fully typed with [TypeScript][6].
5557

5658
## Contribute
5759

5860
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
5961

60-
[1]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
61-
[2]: https://www.typescriptlang.org
62+
[1]: https://docs.nestjs.com/
63+
[2]: https://nodejs.org/
64+
[3]: https://docs.nestjs.com/standalone-applications
65+
[4]: https://github.com/tj/commander.js
66+
[5]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
67+
[6]: https://www.typescriptlang.org

0 commit comments

Comments
 (0)