Skip to content

Commit 866116e

Browse files
committed
Added license, update readme.
1 parent d774885 commit 866116e

File tree

2 files changed

+45
-3
lines changed

2 files changed

+45
-3
lines changed

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 Ajeh Emeke
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
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, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
> A lightweight, promise based alert, prompt and confirm dialog.
44
5+
56
![Vuejs Dialog Plugin](./src/docs/img/html-enabled.png?raw=true "Vuejs Dialog Plugin example")
67
![Vuejs Dialog Plugin](./src/docs/img/demo.gif?raw=true "Vuejs Dialog Plugin usage demo")
78

@@ -12,12 +13,26 @@
1213

1314
## Installation
1415

16+
#### HTML
17+
Include the script:
18+
19+
```html
20+
// Include vuejs
21+
<script type="text/javascript" src="./path/to/vue.min.js"></script>
22+
23+
// Include the vuejs-dialog plugin
24+
<script type="text/javascript" src="./path/to/vuejs-dialog.min.js"></script>
25+
26+
<script>
27+
// Tell Vue to install the plugin.
28+
window.Vue.use(VuejsDialog)
29+
</script>
30+
```
31+
#### NPM
1532
```javascript
1633
// installation via npm
1734
npm install vuejs-dialog
18-
```
1935

20-
```javascript
2136
// import into project
2237
import Vue from "vue"
2338
import VuejsDialog from "vuejs-dialog"
@@ -133,7 +148,7 @@ this.$dialog.confirm(message, options)
133148
```
134149
### Global Configuration
135150
```javascript
136-
// You can also set all your defaults at the oint of installation.
151+
// You can also set all your defaults at the point of installation.
137152
// This will be your global configuration
138153

139154
Vue.use(VuejsDialog, {
@@ -147,3 +162,10 @@ Vue.use(VuejsDialog, {
147162
// Please note that local configurations will be considered before global configurations.
148163
// This gives you the flexibility of overriding the global config on individual call.
149164
```
165+
# License
166+
167+
[MIT](http://opensource.org/licenses/MIT)
168+
169+
## Contributing
170+
171+
Let's make it better :)

0 commit comments

Comments
 (0)