add some informations

This commit is contained in:
Gianni Carafa
2023-11-02 01:00:47 +01:00
parent 180da9e8b6
commit 59041549db

View File

@@ -12,13 +12,28 @@ Freedom of information is an essential pillar of democracy and informed decision
### Features ### Features
- [x] Bypass Paywalls. - [x] Bypass Paywalls
- [x] Bypass CORS. - [x] Remove CORS
- [ ] Docker Container
- [x] Linux Binary
- [x] Mac OS Binary
- [ ] Windows Binary
## How to use ## How to use
1) Download Binary. 1) Download Binary
2) Run Binary. 2) Run Binary
3) Open Browser (Default: https://localhost:2000) 3) Open Browser (Default: https://localhost:2000)
4) Enter URL. 4) Enter URL
5) Hit Enter. 5) Hit Enter
## Configuration
### Environment Variables
| Variable | Description | Default |
| --- | --- | --- |
| `PORT` | Port to listen on | `2000` |
| `PORT_PROXY` | Port the proxy listens on | `3000` |
| `HTTP_PROXY` | Proxy to use | `http://127.0.0.1:3000` |