Skip to content

Commit 5325e65

Browse files
authored
Update README.md
1 parent cc2ca4d commit 5325e65

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
[中文版本](./README_CN.md)
44

5+
⚠️ **Note: Reqable is a non-open source project, and this repository is only used to manage requirements and user feedback.**
6+
57
[Reqable](https://reqable.com/) is a modern cross-platform project, designed for API development, testing, and debugging. Reqable fully supports HTTP1 and HTTP2 and partially supports HTTP3(QUIC).
68

79
![](https://reqable.com/en-US/img/reqable-social-card.jpg)
810

9-
⚠️ **Note: Reqable is a non-open source project, and this repository is only used to manage requirements and user feedback.**
10-
1111
Official website: https://reqable.com
1212

1313
The features of Reqable are simple, beautiful, free, no login is required, and it can be used immediately after installation.
@@ -24,7 +24,7 @@ The Reqable desktop supports Windows/Mac/Linux and integrates API debugging and
2424

2525
Reqable breaks down the barrier between API debugging and testing. For example, APIs can be created from a recording list, and recording can also be performed during API testing.
2626

27-
#### 1. API Debugging
27+
### 1. API Debugging
2828

2929
Reqable uses the classic MITM proxy method for debugging and supports such as rewriting, scripting (Python), breakpoints, and replay.
3030

@@ -49,7 +49,7 @@ Real machine screenshot:
4949

5050
![](/arts/screenshot_en_01.png)
5151

52-
#### 2. API Testing
52+
### 2. API Testing
5353

5454
Reqable can compose API for testing and also supports features such as API collection and history.
5555

@@ -70,3 +70,28 @@ Real machine screenshot:
7070
## Mobile App
7171

7272
Reqable plans to launch a standalone mobile app. But I am currently still focusing on the desktop, the development of the mobile app will start as early as September, it depends on the progress of the desktop. Reqable is developed using Flutter and C++ and needs to be adapted to some specific platforms and interactive methods. I believe that the first version of the mobile app will be released soon.
73+
74+
## Installation
75+
76+
Reqable official website provides the download of the latest version: [Download Now](https://reqable.com/en-US/download). If you want to download the historical version: [Click here](https://github.com/reqable/reqable-app/releases). In addition, on Mac, Reqable provides the `Homebrew` installation.
77+
78+
### Windows Setup
79+
80+
On Windows, you download `Setup.exe` and just follow the setup installation program instructions. There is currently no installation-free version available, mainly because Reqable installation requires writing the registry (associated with `har` and other file formats).
81+
82+
### Mac Setup
83+
84+
On Mac, Reqable provides installation packages for both Apple chip and Intel chip. If you download the DMG file, open it and drag app into the `Applications` folder; if you are using `Homebrew`, please try this command:
85+
```shell
86+
brew install reqable
87+
```
88+
89+
### Linux Setup
90+
91+
The Linux version requires the GTK library. Please confirm whether the system has GTK installed before installation. The Linux installation program is a deb file. We currently only provide the x64 architecture version. You can install it using `apt`:
92+
```shell
93+
sudo apt install reqable-app-linux-x86_64.deb
94+
```
95+
96+
## Documentation
97+
https://reqable.com/en-US/docs/introduction

0 commit comments

Comments
 (0)