Skip to content

Commit 893089c

Browse files
committed
Add readme for SEO and stuff
1 parent 54c1333 commit 893089c

File tree

2 files changed

+63
-1
lines changed

2 files changed

+63
-1
lines changed

vue-toggle-component/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
vue-toggle-component 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.
2+
3+
![npm bundle size](https://img.shields.io/bundlephobia/min/vue-toggle-component)
4+
![npm](https://img.shields.io/npm/dt/vue-toggle-component)
5+
![GitHub issues](https://img.shields.io/github/issues/niels-bosman/vue-toggle-component)
6+
![npm](https://img.shields.io/npm/v/vue-toggle-component)
7+
![GitHub Repo stars](https://img.shields.io/github/stars/niels-bosman/vue-toggle-component?style=social)
8+
9+
10+
![Light theme](https://user-images.githubusercontent.com/25898715/116152862-c273f400-a6e6-11eb-8b4d-1017b92d14a5.gif)
11+
![Dark theme](https://user-images.githubusercontent.com/25898715/116152879-c7d13e80-a6e6-11eb-87b3-9b606184ba1e.gif)
12+
## Getting Started
13+
14+
### Installation
15+
16+
#### Installing the package
17+
```sh
18+
# install with yarn
19+
yarn add vue-toggle-component
20+
21+
# install with npm
22+
npm install vue-toggle-component --save
23+
```
24+
25+
#### Importing the package in your Vue application
26+
```javascript
27+
import VueToggle from 'vue-toggle-component';
28+
```
29+
30+
31+
### Usage
32+
#### Example
33+
```html
34+
<template>
35+
<VueToggle title="Toggle me" id="1"/>
36+
</template>
37+
```
38+
### Vue version support
39+
40+
The main v1 version supports Vue 3.x only, for previous versions of Vue, check the following the table.
41+
42+
| vue Version | vue-toggle-component version |
43+
| ----------- | ---------------------------- |
44+
| `2.x` | `0.1.x` |
45+
| `3.x` | `1.x` |
46+
### Authors
47+
48+
#### Niels Bosman
49+
50+
www.github.com/niels-bosman
51+
52+
https://nielsbosman.dev
53+
54+
#### Mike van Egmond
55+
56+
www.github.com/mve
57+
58+
https://egmond.dev
59+
60+
### License
61+
62+
MIT

vue-toggle-component/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-toggle-component",
3-
"version": "1.0.7",
3+
"version": "1.0.8",
44
"description": "",
55

66
"main": "dist/vue-toggle-component.ssr.js",

0 commit comments

Comments
 (0)