locmeter 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -2
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,17 @@
1
1
  # locmeter
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/locmeter.svg)](https://www.npmjs.com/package/locmeter)
4
+
3
5
  `locmeter` is a dependency-free Node CLI that scans your locally cloned GitHub contribution repos, aggregates added and deleted lines by day, week, or month, and renders a PNG chart.
4
6
 
5
7
  Repository: `jojopirker/locmeter`
6
8
 
9
+ ```bash
10
+ npx locmeter
11
+ ```
12
+
13
+ ![Example locmeter output](./examples/jojo-weekly.png)
14
+
7
15
  ## Requirements
8
16
 
9
17
  - Node.js 18+
@@ -18,6 +26,12 @@ Repository: `jojopirker/locmeter`
18
26
  locmeter
19
27
  ```
20
28
 
29
+ Or without installing globally:
30
+
31
+ ```bash
32
+ npx locmeter
33
+ ```
34
+
21
35
  ## Install
22
36
 
23
37
  ```bash
@@ -67,8 +81,6 @@ That example produced:
67
81
  - total lines changed: `1,059,347`
68
82
  - peak week: `207,431`
69
83
 
70
- ![Example locmeter output](./examples/jojo-weekly.png)
71
-
72
84
  The CLI prints the generated PNG path and JSON path on success.
73
85
 
74
86
  ## Notes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "locmeter",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Render a PNG chart of lines changed over time from your GitHub contribution repos.",
5
5
  "license": "MIT",
6
6
  "preferGlobal": true,