Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ttytm committed Nov 12, 2024
1 parent 4b437f3 commit 02dd32c
Showing 1 changed file with 13 additions and 20 deletions.
33 changes: 13 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,19 @@ higher-level API.
v ~/.vmodules/vibe/curl/setup.vsh
```

## Usage examples
## Usage

#### GET request

> **NOTE**
> For installations as VPM module use
> [!IMPORTANT]
> On Windows, use gcc to compile your V program
>
> ```v
> import ttytm.vibe
> ```sh
> v -cc gcc your_awesome_program.v
> ```
### Examples
#### GET request
```v
import vibe
Expand Down Expand Up @@ -185,23 +187,14 @@ os.rm(cookie_jar)!

## Further information and upcoming features

Vibe is in early development. Additional features will be added based on personal projects and
sensible community needs.
Additional features will be added based on personal projects and sensible community needs.
Contributions like bug 🐛 reports, ⭐ stars and 💡 suggestions are welcome alike!

### Planned

- [x] Linux, macOS, Windows
- [x] Download with progress
- [x] Custom headers
- [x] Proxy support
- [ ] SSL options
- [ ] Extend HTTP methods

### Considered

- Additional curl-compatible formats beyond HTTP.
- Expose response streams / io.Reader implementation
- Support multiple curl versions / allow to opt into newer versions.

Given that the project is being worked on in spare time, please excuse potential delays in replying
due to limited time resources.
Contributions like bug 🐛 reports, ⭐ stars and 💡 suggestions are welcome alike!
Given that the project is being worked on in limited spare time, please excuse potential delays in replying.

0 comments on commit 02dd32c

Please # to comment.