update README.md

Author: 007

README.md

@@ -1,48 +1,49 @@
-# cf_speedtest
+# cf-speedtest
 
-## A simple internet speed test tool/library, which uses https://speed.cloudflare.com (provided by Cloudflare)
+A simple internet speed test CLI tool using [speed.cloudflare.com](https://speed.cloudflare.com)
 
 [![PyPI version](https://img.shields.io/pypi/v/cf-speedtest.svg)](https://pypi.python.org/pypi/cf-speedtest)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/cf-speedtest.svg)](https://pypi.python.org/pypi/cf-speedtest)
-[![PyPI status](https://img.shields.io/pypi/status/cf-speedtest.svg)](https://pypi.python.org/pypi/cf-speedtest)
+[![CI](https://github.com/12932/cf-speedtest/actions/workflows/main.yml/badge.svg)](https://github.com/12932/cf-speedtest/actions/workflows/main.yml)
 [![PyPI downloads](https://img.shields.io/pypi/dm/cf-speedtest.svg)](https://pypi.python.org/pypi/cf-speedtest)
 
-## Installation:
+## Installation
+
 ```bash
-$ pip install -U cf-speedtest
+# Recommended
+uv tool install cf-speedtest
+
+# Or with pip
+pip install -U cf-speedtest
 ```
 
-## Basic CLI usage:
+## Usage
 
-- ### Running a normal speedtest:
-	- `cf_speedtest`
+```bash
+# Run a speedtest
+cf-speedtest
 
-- ### Without verifying SSL:
-	- `cf_speedtest --verifyssl=false`
+# Without SSL verification
+cf-speedtest --verifyssl=false
 
-- ### Specify a [percentile](https://en.wikipedia.org/wiki/Percentile) of measurements to be considered your speed (default 90):
-	- `cf_speedtest --percentile 80`
+# Custom percentile (default 90)
+cf-speedtest --percentile 80
 
-- ### Output measurements to a CSV file:
-	- `cf_speedtest --output speed_data.csv`
+# Output to CSV
+cf-speedtest --output speed_data.csv
+
+# With proxy
+cf-speedtest --proxy socks5://127.0.0.1:1080
+cf-speedtest --proxy http://127.0.0.1:8181
+```
 
-- ### Specify a SOCKS/HTTP proxy to use (with or without authentication):
-	- `cf_speedtest --proxy socks5://127.0.0.1:1080`
-	- `cf_speedtest --proxy socks5://admin:admin@127.0.0.1:1080`
-	- `cf_speedtest --proxy http://127.0.0.1:8181`
-	- `cf_speedtest --proxy http://admin:admin@127.0.0.1:8181`
-	- `cf_speedtest --proxy 127.0.0.1:8181`
+## Requirements
 
-## Programmatic usage:
-	- TODO
+- Python 3.10+
 
-#### TODO:
-	- Programmatic usage
-	- Multi-threaded speedtest
-	- Continuous mode
+## Disclaimers
 
-#### Disclaimers:
-	- This library is purely single-threaded
-	- This library works entirely over HTTP(S), which has some overhead
-	- Latency is measured with HTTP requests
-	- Cloudflare has a global network, but you may be connected to a distant PoP due to ISP peering and other factors
+- Single-threaded
+- Works over HTTP(S), which has some overhead
+- Latency measured via HTTP requests
+- Cloudflare has a global network, but you may connect to a distant PoP due to ISP peering