Skip to content

Commit fd23ff9

Browse files
committed
docs: add installation section to README
1 parent c42e59a commit fd23ff9

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,42 @@ A zero-config CLI that parses your Git log and renders a contribution heatmap po
1111

1212
---
1313

14-
## Quick Start
14+
## Installation
15+
16+
**Run directly (no install needed):**
17+
```bash
18+
npx git-poster
19+
```
1520

21+
**Install globally:**
1622
```bash
23+
npm install -g git-poster
24+
git-poster
25+
```
26+
27+
**Install locally in a project:**
28+
```bash
29+
npm install --save-dev git-poster
1730
npx git-poster
1831
```
1932

33+
**PNG support** (optional):
34+
```bash
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+
```bash
46+
cd your-repo
47+
git-poster
48+
```
49+
2050
That's it. Run from any Git repository and get `git-poster.svg` in the current directory.
2151

2252
---

0 commit comments

Comments
 (0)