Skip to content

Commit 4655b49

Browse files
committed
update readme
1 parent e154895 commit 4655b49

2 files changed

Lines changed: 59 additions & 2 deletions

File tree

README.md

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
1-
# rip
2-
Rest in peace(s) - the load testing CLI tool
1+
# RIP
2+
3+
This is a HTTP load testing tool that run requests concurrently. Written as a Golang learning project.
4+
5+
![RIP](./rip.png)
6+
7+
## Features
8+
9+
- Run requests concurrently
10+
- Set a timer in second for how long it should run
11+
- Outputs table of statistics for the end result
12+
13+
## Coming
14+
15+
- JSON output of the result
16+
- Support multiple URLs
17+
18+
## Usage
19+
20+
Install the binary from <https://github.com/bjarneo/rip/releases>, or go directly to the build the binary manually step.
21+
22+
```bash
23+
$ rip -c 100 -t 10 https://your.domain.com
24+
```
25+
26+
### The default values
27+
28+
```
29+
Usage of rip
30+
-t int
31+
How many seconds to run the test (default: 60)
32+
-c float
33+
How many concurrent users to simulate (default: 10)
34+
35+
```
36+
37+
## Get it up and running [DEV]
38+
39+
```bash
40+
# Install dependencies
41+
go install
42+
43+
# By using the go binary directly
44+
go run main.go
45+
```
46+
47+
## Build the binary manually
48+
49+
```bash
50+
# Build binary
51+
go build
52+
53+
# Now it will be available as "rip"
54+
rip http://localhost:1337
55+
```
56+
57+
## LICENSE
58+
59+
See [LICENSE](./LICENSE)

rip.png

52.8 KB
Loading

0 commit comments

Comments
 (0)