Skip to content

Commit 098efe2

Browse files
author
Lars Eichler
committed
Readme and license update
1 parent 3f9d042 commit 098efe2

File tree

2 files changed

+43
-8
lines changed

2 files changed

+43
-8
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Lars Eichler
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,26 @@ $ npm install --save vue-pell-editor
1212
$ yarn add vue-pell-editor
1313
```
1414

15-
**HTML**:
15+
## Usage
16+
17+
main.js:
18+
19+
```javascript
20+
import Vue from 'vue'
21+
import VuePellEditor from 'vue-pell-editor
22+
23+
Vue.use(VuePellEditor)
24+
```
25+
26+
example.vue:
1627
1728
```vue
1829
<template>
19-
<VuePellEditor
30+
<vue-pell-editor
31+
v-model="editorContent"
2032
:actions="editorOptions"
2133
:content="editorContent"
2234
:placeholder="editorPlaceholder"
23-
v-model="editorContent"
2435
:style-with-css="false"
2536
:classes="editorClasses"
2637
default-paragraph-separator="p"
@@ -30,8 +41,6 @@ $ yarn add vue-pell-editor
3041
</template>
3142
3243
<script>
33-
import VuePellEditor from 'vue-pell-editor'
34-
3544
export default {
3645
data: () => ({
3746
editorOptions: [
@@ -71,9 +80,6 @@ export default {
7180
selected: 'pell-button-selected'
7281
}
7382
}),
74-
components: {
75-
VuePellEditor
76-
},
7783
methods: {
7884
doSomething() {
7985
console.log('Hello')
@@ -87,3 +93,11 @@ export default {
8793
```
8894
8995
For the pell-editor-options have a look at the [pell repository](https://github.com/jaredreich/pell#api)
96+
97+
## License
98+
99+
vue-pell-editor is open source and released under the [MIT License](LICENSE).
100+
101+
Copyright (c) 2018 [Lars Eichler](https://twitter.com/cinkon).
102+
103+
> _PS: You're a happy user of vue-pell-editor. Let me know via Twitter: [@cinkon](https://twitter.com/cinkon)_.

0 commit comments

Comments
 (0)