Skip to content

Commit 853e4ef

Browse files
committed
[DOC]: Create a basic documentation
1 parent 93bb3d4 commit 853e4ef

File tree

1 file changed

+3
-85
lines changed

1 file changed

+3
-85
lines changed

README.md

Lines changed: 3 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Use specific components:
3232

3333
```javascript
3434
import Vue from 'vue'
35-
import { Test } from 'vue-typed-js'
35+
import { VueTypedJs } from 'vue-typed-js'
3636

37-
Vue.component('test', Test)
37+
Vue.component('vue-typed-js', VueTypedJs)
3838
```
3939

4040
**⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.**
@@ -50,17 +50,6 @@ import VueTypedJs from 'vue-typed-js/dist/vue-typed-js.common'
5050
Vue.use(VueTypedJs)
5151
```
5252

53-
Use specific components:
54-
55-
```javascript
56-
import 'vue-typed-js/dist/vue-typed-js.css'
57-
import { Test } from 'vue-typed-js/dist/vue-typed-js.common'
58-
59-
Vue.component('test', Test)
60-
```
61-
62-
**⚠️ You may have to setup your bundler to embed the css file in your page.**
63-
6453
## Browser
6554

6655
```html
@@ -78,12 +67,6 @@ Install all the components:
7867
Vue.use(VueTypedJs)
7968
```
8069

81-
Use specific components:
82-
83-
```javascript
84-
Vue.component('test', VueTypedJs.Test)
85-
```
86-
8770
## Source import
8871

8972
Install all the components:
@@ -95,17 +78,6 @@ import VueTypedJs from 'vue-typed-js/src'
9578
Vue.use(VueTypedJs)
9679
```
9780

98-
Use specific components:
99-
100-
```javascript
101-
import Vue from 'vue'
102-
import { Test } from 'vue-typed-js/src'
103-
104-
Vue.component('test', Test)
105-
```
106-
107-
**⚠️ You need to configure your bundler to compile `.vue` files.** More info [in the official documentation](https://vuejs.org/v2/guide/single-file-components.html).
108-
10981
# Usage
11082

11183
> TODO
@@ -116,60 +88,6 @@ Vue.component('test', Test)
11688
11789
---
11890

119-
# Plugin Development
120-
121-
## Installation
122-
123-
The first time you create or clone your plugin, you need to install the default dependencies:
124-
125-
```
126-
npm install
127-
```
128-
129-
## Watch and compile
130-
131-
This will run webpack in watching mode and output the compiled files in the `dist` folder.
132-
133-
```
134-
npm run dev
135-
```
136-
137-
## Use it in another project
138-
139-
While developping, you can follow the install instructions of your plugin and link it into the project that uses it.
140-
141-
In the plugin folder:
142-
143-
```
144-
npm link
145-
```
146-
147-
In the other project folder:
148-
149-
```
150-
npm link vue-typed-js
151-
```
152-
153-
This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.
154-
155-
## Publish to npm
156-
157-
You may have to login to npm before, with `npm adduser`. The plugin will be built in production mode before getting published on npm.
158-
159-
```
160-
npm publish
161-
```
162-
163-
## Manual build
164-
165-
This will build the plugin into the `dist` folder in production mode.
166-
167-
```
168-
npm run build
169-
```
170-
171-
---
172-
173-
## License
91+
# License
17492

17593
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)