Skip to content

Commit 7ca6775

Browse files
committed
README.md updates
1 parent 2d0294a commit 7ca6775

File tree

2 files changed

+35
-7
lines changed

2 files changed

+35
-7
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
`sttr` is command line software that allows you to quickly run various transformation operations on the string.
66

7-
```sh
7+
```go
88
// With input prompt
99
sttr
1010

@@ -19,17 +19,45 @@ sttr -i "your string"
1919

2020
# Installation
2121

22-
WIP
22+
## Quick install
23+
24+
You can run the below `curl` to install it somewhere in your PATH for easy use.
25+
Ideally it will be installed at `./bin` folder
26+
27+
```go
28+
curl -sfL https://raw.githubusercontent.com/abhimanyu003/sttr/main/install.sh | sh
29+
```
30+
31+
## Homebrew
32+
33+
If you are on macOS and using Homebrew, you can install `sttr` with the following:
34+
35+
```go
36+
brew tap abhimanyu003/sttr
37+
brew install sttr
38+
```
39+
40+
## Go
41+
42+
```go
43+
go install github.com/abhimanyu003/sttr@latest
44+
```
45+
46+
## Manually
47+
48+
Download the pre-compiled binaries from the [Release!](https://github.com/abhimanyu003/sttr/releases) page and copy them to the desired location.
2349

2450
# Guide
2551

2652
* After installation simply run `sttr` command.
27-
```
53+
54+
```go
2855
// With input prompt
29-
sttr
30-
( Press two enter to open operation menu )
3156

32-
// Direct string input
57+
sttr
58+
// ( Press two enter to open operation menu )
59+
60+
// You can also provide string directly without any prompt.
3361
sttr -i "your string"
3462
```
3563

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module code
1+
module sttr
22

33
go 1.17
44

0 commit comments

Comments
 (0)