1 parent c42e59a commit fd23ff9Copy full SHA for fd23ff9
1 file changed
README.md
@@ -11,12 +11,42 @@ A zero-config CLI that parses your Git log and renders a contribution heatmap po
11
12
---
13
14
-## Quick Start
+## Installation
15
+
16
+**Run directly (no install needed):**
17
+```bash
18
+npx git-poster
19
+```
20
21
+**Install globally:**
22
```bash
23
+npm install -g git-poster
24
+git-poster
25
26
27
+**Install locally in a project:**
28
29
+npm install --save-dev git-poster
30
npx git-poster
31
```
32
33
+**PNG support** (optional):
34
35
+npm install -g sharp
36
+git-poster --png
37
38
39
+> Requires Node.js 18 or later.
40
41
+---
42
43
+## Quick Start
44
45
46
+cd your-repo
47
48
49
50
That's it. Run from any Git repository and get `git-poster.svg` in the current directory.
51
52
0 commit comments