summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6c77f46..83228bd 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
# The HTTP Client for WeChat Mini Program
+
+Wave is an HTTP client designed for WeChat Mini Programs. It aims to enhance
+the developer experience when sending HTTP requests.
+
+## Installation
+
+To install the package, navigate to the root directory of your WeChat Mini
+Program. You can install it using NPM:
+
+```bash
+npm i @beautiful-bubble/wave
+```
+
+After installation, remember to run the "Build NPM Package" command in the
+WeChat Mini Program development tools.
+
+## License
+
+The package is released under [the MIT license](LICENSE).