Skip to content

Commit b2d7541

Browse files
committed
add motivation and enhance installation
1 parent 27817c5 commit b2d7541

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,33 @@
22

33
This is patch tool using comment directive.
44

5+
## Motivation
6+
7+
This aims to make scaffolding more easily and safely.
8+
9+
Sometimes we can see some templates that don't work after generating from them.
10+
We should build and test those templates on CI pipelines, but, it is hard to test templates correctness because templates usually does'nt work before generation.
11+
So, this `patchr` aims to create a `living` scaffolding template.
12+
513
## Installation
614

7-
```
15+
Download from [Releases](https://github.com/wreulicke/patchr/releases)
16+
17+
```bash
18+
# Mac
19+
curl -o patchr -sL "https://github.com/wreulicke/patchr/releases/download/v0.0.1/patchr_0.0.1_darwin_arm64"
20+
curl -o patchr -sL "https://github.com/wreulicke/patchr/releases/download/v0.0.1/patchr_0.0.1_darwin_amd64"
21+
22+
# Linux
23+
curl -o patchr -sL "https://github.com/wreulicke/patchr/releases/download/v0.0.1/patchr_0.0.1_linux_amd64"
24+
curl -o patchr -sL "https://github.com/wreulicke/patchr/releases/download/v0.0.1/patchr_0.0.1_linux_arm64"
25+
26+
# Windows
27+
curl -o patchr -sL https://github.com/wreulicke/patchr/releases/download/v0.0.1/patchr_0.0.1_windows_amd64.exe
28+
curl -o patchr -sL https://github.com/wreulicke/patchr/releases/download/v0.0.1/patchr_0.0.1_windows_arm64.exe
29+
30+
chmod +x patchr
31+
mv patchr /usr/local/bin
832
```
933

1034
## Usage

0 commit comments

Comments
 (0)