🚀 chore(package.json): update package version to 0.1.7

✨ feat(readme.md): add documentation for custom provider and license information

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-cdn-uploader",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "A Vite plugin to upload built files to various CDN providers",
   "main": "dist/index.js",
   "scripts": {

readme.md

@@ -1,3 +1,71 @@
-# Vite CDN Uploader Plugin
+# Vite CDN Uploader Plugin 🚀
 
-In development, I will update soon.
+The Vite CDN Uploader Plugin is a handy utility to automatically upload build files from Vite projects to various CDN providers. It currently supports Amazon S3 and Custom Providers.
+
+## Installation 💻
+
+Install the plugin via npm or yarn:
+
+```bash
+npm install --save-dev vite-cdn-uploader
+```
+
+or
+
+```bash
+yarn add -D vite-cdn-uploader
+```
+
+## Usage 🛠
+
+First, import the plugin in your Vite configuration file:
+
+```javascript
+import { cdnUploaderPlugin, providers } from "vite-cdn-uploader"
+```
+
+Then, add the plugin to the `plugins` array in your Vite configuration:
+
+```javascript
+export default {
+  plugins: [
+    cdnUploaderPlugin({
+      provider: new providers.AwsS3Provider(),
+    }),
+  ],
+};
+```
+
+### Custom Provider 🎛
+
+Create a custom provider by defining a class with a `config` method and an `upload` method:
+
+```javascript
+class CustomProvider {
+    config() {
+        // Provider Configs
+        return {};
+    }
+    async upload(file, filePath) {
+        // Upload Process
+    }
+}
+```
+
+### Vite Configuration 📝
+
+Include your custom provider in your Vite configuration:
+
+```javascript
+export default {
+  plugins: [
+    cdnUploaderPlugin({
+      provider: new CustomProvider(),
+    }),
+  ],
+};
+```
+
+## License 📄
+
+MIT