Skip to content

Commit 305e599

Browse files
committed
📖 Update README.md with new documentation
Closes #6
1 parent 0af5110 commit 305e599

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ yarn-debug.log*
66
yarn-error.log*
77
test/unit/coverage
88
coverage/
9+
deploy-docs.sh
910

1011
# Editor directories and files
1112
.editorconfig

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
[![Build Status](https://travis-ci.org/kimuraz/vue-rest.svg?branch=dev)](https://travis-ci.org/kimuraz/vue-rest)
22
# vue-rest
33

4-
> Plugin for using vue + axios for REST API consumption
4+
Plugin for using vue + axios for REST API CRUD operations
55

66
## Installation
77

88
```shell
99
$ npm i -S vue-rest
10+
11+
OR
12+
13+
$ yarn add vue-rest
1014
```
1115

1216
## Documentation
1317

14-
[Gitbook](https://kimuraz.gitbooks.io/vue-rest/content/)
18+
Checkout the docs:
19+
20+
:book: [Docs](https://kimuraz.github.io/vue-rest/)
1521

1622
## Examples
1723

0 commit comments

Comments
 (0)