Merge pull request #11 from niels-bosman/feature/readme-upgrade

Feature/readme upgrade

Author: niels-bosman

README.md

@@ -1,41 +1,62 @@
-# Vue Toggle component
-
-This is a project that makes it easier to use a (checkbox) toggle component that's modern.
-
-![DEMO](https://user-images.githubusercontent.com/25898715/113936516-26964d00-97f8-11eb-850d-7cc74690ccf6.gif)
+vue-toggle-components makes an ease to use, lightweight and highly customizable toggle component for [Vue.js](https://vuejs.org/). This component is available in both light and dark mode and it supports Vue 3.
 
 ![npm bundle size](https://img.shields.io/bundlephobia/min/vue-toggle-component)
 ![npm](https://img.shields.io/npm/dt/vue-toggle-component)
 ![GitHub issues](https://img.shields.io/github/issues/niels-bosman/vue-toggle-component)
 ![npm](https://img.shields.io/npm/v/vue-toggle-component)
 ![GitHub Repo stars](https://img.shields.io/github/stars/niels-bosman/vue-toggle-component?style=social)
 
-## Installation
 
-#### npm
-```bash
-npm install --save vue-toggle-component
-```
+![Light theme](https://user-images.githubusercontent.com/25898715/116152862-c273f400-a6e6-11eb-8b4d-1017b92d14a5.gif)
+![Dark theme](https://user-images.githubusercontent.com/25898715/116152879-c7d13e80-a6e6-11eb-87b3-9b606184ba1e.gif)
+## Getting Started
 
-## Import
+### Installation
+
+#### Installing the package
+```sh
+# install with yarn
+yarn add vue-toggle-component
+
+# install with npm
+npm install vue-toggle-component --save
+```
 
+#### Importing the package in your Vue application
 ```javascript
 import VueToggle from "@vue-toggle-component";
 ```
+### Vue version support
 
-## Example
-```
-<vue-toggle title="Toggle me" id="1" />
+The main v2 version supports Vue 3.x only, for previous versions of Vue, check the following the table.
+
+| vue Version | vue-toggle-component version |
+| ----------- | ---------------------------- |
+| `2.x`       | `0.1.x`                      |
+| `3.x`       | `1.x`                        |
+
+### Usage
+#### Example
+```html
+<template>
+  <VueToggle title="Toggle me" id="1"/>
+</template>
 ```
 
-### Author
+### Authors
+
+#### Niels Bosman
+
+www.github.com/niels-bosman
+
+https://nielsbosman.dev
 
-Niels Bosman
+#### Mike van Egmond
 
-Github: www.github.com/niels-bosman
+www.github.com/mve
 
-Website: https://nielsbosman.dev
+https://egmond.dev
 
 ### License
 
-ISC
+MIT

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-toggle-component",
-  "version": "0.2.0",
+  "version": "1.0",
   "scripts": {
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build",