Skip to content

Commit f23b810

Browse files
committed
docs: update README
1 parent 32c8c84 commit f23b810

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,28 @@ This tool has been developed and tested exclusively on **macOS**. It is not guar
3333
## Limitations
3434
Only comments of the double slash "`//`" type can be used at this time.
3535

36+
## Install
37+
```shell
38+
git clone --depth=1 https://github.com/andreas-timm/code-signature-ts.git ~/.local/share/code-signature-ts
39+
```
40+
```shell
41+
cd ~/.local/share/code-signature-ts
42+
```
43+
```shell
44+
bun install -p
45+
```
46+
```shell
47+
ln -s ~/.local/share/code-signature-ts/src/code-signature.ts ~/.local/bin/code-signature
48+
```
49+
3650
## Usage
3751
### Check
3852
```shell
39-
code-signature --verify code-file.ts
40-
OK: 0x0000000000000000000000000000000000000000
53+
code-signature -v src/code-signature.ts
54+
OK: 0x630C6C3180d3b4B6912644D046f6769dA3e54843
4155
```
4256

43-
### Integration with pass/gpt
57+
### Integration with pass/gpg
4458
```shell
4559
MNEMONIC=$(pass show mnemonic) code-signature --write code-file.ts
4660
```

0 commit comments

Comments
 (0)