Skip to content

Commit b04889f

Browse files
docs: add proper description to package.json and README.md (#7)
1 parent a9946ca commit b04889f

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
![TypeScript: Strict](https://img.shields.io/badge/typescript-strict-brightgreen.svg)
66
[![NPM version](https://badge.fury.io/js/template-typescript-node-package.svg)](http://badge.fury.io/js/template-typescript-node-package)
77

8-
> TODO: description!
8+
> Template TypeScript Node.js package with all the CI bells & whistles I commonly use.
99
1010
## Usage
1111

@@ -14,7 +14,11 @@ npm i template-typescript-node-package
1414
```
1515

1616
```ts
17-
// TODO: Usage!
17+
import { greet } from "template-typescript-node-package";
18+
19+
greet({
20+
message: "Hello, world!",
21+
});
1822
```
1923

2024
## Development

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"author": "Josh Goldberg <[email protected]>",
3-
"description": "TODO: description!",
3+
"description": "Template TypeScript Node.js package with all the CI bells & whistles I commonly use. ✨",
44
"devDependencies": {
55
"@semantic-release/commit-analyzer": "^9.0.2",
66
"@semantic-release/git": "^10.0.1",

0 commit comments

Comments
 (0)