Skip to content

Commit 70f3865

Browse files
committed
Add badges and Development section to README
1 parent 8d9ce00 commit 70f3865

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# unknownutil
22

3+
[![npm](http://img.shields.io/badge/available%20on-npm-lightgrey.svg?logo=npm&logoColor=white)](https://www.npmjs.com/package/unknownutil)
34
[![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno)](https://deno.land/x/unknownutil)
45
[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/unknownutil/mod.ts)
56
[![Test](https://github.com/lambdalisue/deno-unknownutil/workflows/Test/badge.svg)](https://github.com/lambdalisue/deno-unknownutil/actions?query=workflow%3ATest)
7+
[![npm version](https://badge.fury.io/js/unknownutil.svg)](https://badge.fury.io/js/unknownutil)
68

79
A utility pack for handling `unknown` type.
810

@@ -141,6 +143,40 @@ ensureLike({}, b); // Now 'b' is 'Record<string, unknown>'
141143
ensureLike({ foo: "", bar: 0 }, b); // Now 'b' is '{foo: string, bar: number}'
142144
```
143145

146+
## Development
147+
148+
Lint code like:
149+
150+
```text
151+
make lint
152+
```
153+
154+
Format code like
155+
156+
```text
157+
make fmt
158+
```
159+
160+
Check types like
161+
162+
```text
163+
make type-check
164+
```
165+
166+
Run tests like:
167+
168+
```text
169+
make test
170+
```
171+
172+
Publish new version with:
173+
174+
```
175+
npm version {major/minor/patch}
176+
npm publish
177+
git push --tags
178+
```
179+
144180
## License
145181

146182
The code follows MIT license written in [LICENSE](./LICENSE). Contributors need

0 commit comments

Comments
 (0)