Update README.md and add LICENSE info

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jason Ilicic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,86 @@
-# vue-umami-plugin
+# Vue Umami Plugin
+
+The Vue Umami Plugin integrates Umami analytics by loading the library and injecting it into your application's DOM, allowing you to easily track page views and events.
+
+## Background and Scope
+
+This library was created to reduce duplication and streamline the integration of Umami analytics into a number of my personal Vue projects. Though, I decided to share it with the community in the hope that others may find it useful for similar purposes, either as-is, or as a starting point.
+
+Given its focused nature, the plugin has limitations and may lack functionality available through the official Umami library API.
+
+## Features
+
+- **Automatic Page Tracking:** Automatically track page views through your Vue router.
+- **Event Tracking:** Easily track custom events with minimal configuration.
+- **Lazy Loading:** The Umami script is loaded only when the document is ready, ensuring minimal impact on performance.
+- **Queue System:** Events are queued until the Umami script is loaded, ensuring no events are lost.
+
+## Requirements
+
+- Vue 3.x
+- Vue Router (optional, for automatic page tracking)
+
+## Installation
+
+To install and use this plugin, you can include the library via npm:
+
+```bash
+npm install @jaseeey/vue-umami-plugin
+```
+
+## Usage
+
+To use the Vue Umami Plugin in your project, import it and use it within your Vue application setup:
+
+```javascript
+import { createApp } from 'vue';
+import { VueUmamiPlugin } from '@jaseeey/vue-umami-plugin';
+import App from './App.vue';
+import router from './router';
+
+const app = createApp(App);
+
+app.use(VueUmamiPlugin, {
+    websiteID: 'YOUR_UMAMI_WEBSITE_ID',
+    router
+});
+
+app.use(router).mount('#app');
+```
+
+### Tracking Events
+
+To track custom events:
+
+```javascript
+import { trackUmamiEvent } from 'vue-umami-plugin';
+
+trackUmamiEvent('button-click', { buttonName: 'subscribe' });
+```
+
+## API Reference
+
+### `VueUmamiPlugin(options)`
+
+Initialises the Umami tracking plugin with specified options.
+
+- **Parameters**
+    - `options` (Object):
+        - `websiteID` (String): The Umami website ID required for tracking.
+        - `router` (Router, optional): The Vue Router instance for automatic page tracking.
+
+### `trackUmamiEvent(event, eventParams)`
+
+Sends a custom tracking event to Umami.
+
+- **Parameters**
+    - `event` (String): The name of the event to track.
+    - `eventParams` (Object, optional): Additional parameters for the event; typically includes details like page URL or user actions.
+
+## Contributions
+
+You can contribute to this project by submitting a pull request or reporting issues in the issues section of this repository.
+
+## License
+
+This project is licensed under the MIT License, see the [LICENSE](LICENSE) file for details.