Skip to content

Commit f091043

Browse files
committedDec 11, 2021
updating docs for providers
1 parent 9e3797e commit f091043

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed
 

‎README.md

+18-12
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,30 @@
88

99

1010

11-
The best part about this library is that it is not strictly coupled to one request handling library like [vue-axios](https://github.com/imcvampire/vue-axios). You will be able to use it with different libraries.
11+
The best part about this library is that it is not strictly coupled to one request handling library like [vue-axios](https://github.com/imcvampire/vue-axios). You will be able to use it with different libraries.
1212

1313
For now it is tested to work with [vue-resource](https://github.com/pagekit/vue-resource) and [axios](https://github.com/mzabriskie/axios) (using [vue-axios](https://github.com/imcvampire/vue-axios) wrapper).
1414

1515
**WARNING:** From version 1.3.0 default request library is `axios` using `vue-axios` wrapper plugin.
1616

1717
This library was inspired by well known authentication library for Angular called [Satellizer](https://github.com/sahat/satellizer) developed by [Sahat Yalkabov](http://sahatyalkabov.com). They share almost identical configuration and API so you can easily switch from Angular to Vue.js project.
1818

19-
## Supported OAuth providers and configurations
2019

21-
1. Facebook (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L21)
22-
2. Google (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L34)
23-
3. Github (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L49)
24-
4. Instagram (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L61)
25-
5. Twitter (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L72)
26-
6. Bitbucket (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L81)
27-
7. LinkedIn (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L93)
28-
8. Microsoft Live (https://github.com/dgrubelic/vue-authenticate/blob/master/src/options.js#L106)
20+
## OAuth Providers
21+
22+
Support for the following OAuth providers are included out of the box:
23+
24+
- GitHub
25+
- Facebook
26+
- Google
27+
- Bitbucket
28+
- LinkedIn
29+
- Twitter
30+
- Instagram
31+
- Microsoft Live
32+
33+
For more on the configuration of existing providers and adding your
34+
own, see the documentation on [OAuth provider configurations](./docs/providers.md).
2935

3036
## Installation
3137
```bash
@@ -42,7 +48,7 @@ import axios from 'axios';
4248
Vue.use(VueAxios, axios)
4349
Vue.use(VueAuthenticate, {
4450
baseUrl: 'http://localhost:3000', // Your API domain
45-
51+
4652
providers: {
4753
github: {
4854
clientId: '',
@@ -138,7 +144,7 @@ Once you have created VueAuthenticate instance, you can use it in Vuex store lik
138144

139145
```javascript
140146
export default new Vuex.Store({
141-
147+
142148
// You can use it as state property
143149
state: {
144150
isAuthenticated: false

‎docs/providers.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Provider Configurations
1+
# OAuth Provider Configurations
22

33
The vue-authenticate packages provides support for the following
44
OAuth providers out of the box:
@@ -10,6 +10,7 @@ OAuth providers out of the box:
1010
- LinkedIn
1111
- Twitter
1212
- Instagram
13+
- Microsoft Live
1314

1415
For any other provider, it is simply a question of providing the right
1516
provider configuration in the options to your vue-authenticate instance.

0 commit comments

Comments
 (0)
Please sign in to comment.