Skip to content

Commit 5971a2e

Browse files
committed
README.md: update and add example
1 parent 5059d26 commit 5971a2e

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# write-npmstat
1+
# About The Project
2+
23
write-npmstat makes it easy to collect, filter and save npm statistics to csv files.
4+
5+
# Installation
6+
7+
write-npmstat requires `npm-stat-api`, `enum`, `csv-writer` and `csv-parser` packages.
8+
9+
```sh
10+
npm install write-npmstat
11+
```
12+
13+
# Usage
14+
15+
```js
16+
const WriteNpmStat = require("write-npmstat");
17+
18+
packageName = "npm-stat-api"
19+
outDir = "stats/npm-stat-api"
20+
const writenpmstat = new WriteNpmStat(packageName, outDir);
21+
22+
writenpmstat.datePeriod = "month";
23+
writenpmstat.writeNpmStat("2022", "2022-03");
24+
```
25+
26+
# Contact
27+
28+
Join our [discussions](https://github.com/veghdev/write-npmstat/discussions) page if you have any questions or comments.
29+
30+
# License
31+
32+
Copyright © 2022.
33+
34+
Released under the [Apache 2.0 License](https://github.com/veghdev/write-npmstat/blob/main/LICENSE).

0 commit comments

Comments
 (0)