aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a7f57d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# uwufy
+[![npm](https://img.shields.io/npm/v/uwufy.svg)](https://www.npmjs.com/package/uwufy)
+[![license](https://img.shields.io/badge/license-MIT_License_with_anime_exception-green.svg)](https://github.com/8cy/npm-uwufy/blob/master/LICENSE)
+
+[![npmbadge](https://nodei.co/npm/uwufy.png)](https://nodei.co/npm/uwufy/)
+
+The simplest UwU package of all.
+
+Yes, this **works** really well with Discord bot APIs!
+
+## Install
+```sh
+$ npm install uwufy
+```
+
+# Usage
+```js
+const uwufy = require('uwufy');
+
+console.log(uwufy('IF YOU SEE THIS THEN THE UWUFICATION WAS SUCCESSFULL'));
+```
+
+# Output
+```sh
+$ IF YOU SEE THIS THEN THE UWUFICATION WAS SUCCESSFULL
+```
+
+## Links
+
+* [Website](https://cyne.cf)
+* [NPM](https://npmjs.com/uwufy)