Skip to content

Commit 7f50dd5

Browse files
Merge pull request #47 from SagarMaheshwary/docs/v0.7.0
docs: refine installation section in README
2 parents f61aebc + f2314ea commit 7f50dd5

1 file changed

Lines changed: 23 additions & 12 deletions

File tree

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,40 +105,51 @@ Example output:
105105

106106
## Installation
107107

108-
**Go Install**
108+
reqlog is a single binary with no runtime dependencies.
109+
110+
### Go Install
109111

110112
```bash
111113
go install github.com/sagarmaheshwary/reqlog/cmd/reqlog@latest
112114
```
113115

114-
**macOS / Linux**
116+
### macOS / Linux (Quick Install)
115117

116118
```bash
117119
curl -sSL https://raw.githubusercontent.com/sagarmaheshwary/reqlog/master/install.sh | bash
118120
```
119121

120-
- Auto-detects OS/arch
121-
- Installs latest version
122-
- Installs to `/usr/local/bin`
122+
This script:
123+
124+
- Detects OS and architecture automatically
125+
- Downloads the latest release
126+
- Installs `reqlog` to `/usr/local/bin`
127+
128+
### Manual Installation (Linux / macOS)
123129

124-
Verify:
130+
You can also install manually from the latest release:
131+
132+
1. Download the appropriate binary from:
133+
[https://github.com/sagarmaheshwary/reqlog/releases](https://github.com/sagarmaheshwary/reqlog/releases)
134+
2. Extract and install:
125135

126136
```bash
127-
reqlog -v
137+
tar -xzf reqlog-linux-amd64.tar.gz
138+
sudo mv reqlog /usr/local/bin/
128139
```
129140

130-
**Windows**
141+
### Windows
131142

132-
Download from:
143+
Download the latest release from:
133144

134145
[https://github.com/sagarmaheshwary/reqlog/releases](https://github.com/sagarmaheshwary/reqlog/releases)
135146

136147
Then:
137148

138-
- unzip
139-
- add to `PATH`
149+
- Extract the archive
150+
- Add the binary to your `PATH`
140151

141-
Verify:
152+
### Verify installation
142153

143154
```bash
144155
reqlog -v

0 commit comments

Comments
 (0)