chore: add readme

cordiverse · Feb 12, 2024 · 48b0ded · 48b0ded
1 parent 1af22fe
commit 48b0ded
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+./packages/core/README.md
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "undios",
-  "description": "Axios-style HTTP client service for Cordis",
+  "description": "Fetch-based axios-style HTTP client",
   "version": "0.1.0",
   "type": "module",
   "main": "lib/index.js",

diff --git a/packages/core/readme.md b/packages/core/readme.md
@@ -1,3 +1,11 @@
-# @cordisjs/plugin-http
+# Undios
 
-Axios-style HTTP client service for Cordis.
+Fetch-based axios-style HTTP client.
+
+> "und" comes from undici, an HTTP/1.1 client officially supported by Node.js team.
+> "ios" comes from axios, a popular HTTP client for browser and Node.js.
+
+## Features
+
+- Browser and Node.js support
+- Proxy agents (HTTP / HTTPS / SOCKS)
diff --git a/packages/proxy-agent/readme.md b/packages/proxy-agent/readme.md
@@ -1 +1,3 @@
-# @cordisjs/plugin-http-socks
+# undios-proxy-agent
+
+Supports HTTP, HTTPS, and SOCKS proxy agents for [undios](https://github.com/cordiverse/undios).