From 02dd32cc1c5e01b61bebf5cae93dd363aaaee281 Mon Sep 17 00:00:00 2001
From: Turiiya <34311583+ttytm@users.noreply.github.com>
Date: Tue, 12 Nov 2024 05:19:52 +0100
Subject: [PATCH] docs: update readme

---
 README.md | 33 +++++++++++++--------------------
 1 file changed, 13 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 0f7d57e..5b093c7 100644
--- a/README.md
+++ b/README.md
@@ -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
 
@@ -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.