Pr/31

README.md

@@ -5,7 +5,7 @@ Handling Google sign-in and sign-out for Vue.js applications.
 ![GitHub](https://img.shields.io/github/license/guruahn/vue-google-oauth2.svg)
 ![vue-google-oauth2](https://img.shields.io/npm/dt/vue-google-oauth2.svg)
 
-We support [TypeScript](https://www.typescriptlang.org/) 😎 but not [Nuxt](https://ko.nuxtjs.org/). 😢
+We support [TypeScript](https://www.typescriptlang.org/) and [Nuxt](https://ko.nuxtjs.org/). 😎 
 
 [Front-end Demo](https://stupefied-darwin-da9533.netlify.com/)
 ## Installation
@@ -33,7 +33,37 @@ Vue.use(GAuth, gauthOption)
 ```
 Please Don't use `plus.login` scope. [It will be deprecated.](https://developers.google.com/identity/sign-in/web/quick-migration-guide)
 
-### Options
+### Initialization for Nuxt
+1. creates plug-in file for nuxt
+
+	```javascript
+	// plugins/vue-google-oauth2.js
+	// file name can be changed to whatever you want
+	import Vue from 'vue'
+	import GAuth from 'vue-google-oauth2'
+
+	const gauthOption = {
+	  clientId: 'CLIENT_ID.apps.googleusercontent.com',
+	  scope: 'profile email',
+	  prompt: 'select_account'
+	}
+	Vue.use(GAuth, gauthOption)
+
+	```
+
+2. adds plugin to nuxt config file
+	```javascript
+	...
+	plugins: [
+	  ...
+      './plugins/vue-google-oauth2'
+	],
+
+	...
+
+	```
+
+## Options
 | Property     | Type     | Required        | Description     |
 |--------------|----------|-----------------|-----------------|
 | clientId     | String   | Required.       | The app's client ID, found and created in the Google Developers Console. |
@@ -52,54 +82,36 @@ Please Don't use `plus.login` scope. [It will be deprecated.](https://developers
 | getAuthCode  | function for getting authCode | Function  |
 | signOut      | function for sign-out | Function  |
 
-## Usage - Getting authorization code
->The `authCode` that is being returned is the `one-time code` that you can send to your backend server, so that the server can exchange for its own access_token and refresh_token.
+
+## Usages
+### Getting authorization code
+The `authCode` that is being returned is the `one-time code` that you can send to your backend server, so that the server can exchange for its own access_token and refresh_token.
+
+The `access_token` and `refresh_token` can be saved in backend storage for reuse and refresh. In this way, you can avoid exposing your api key or secret key whenever you need to use various google APIs.
 
 ```javascript
-this.$gAuth.getAuthCode()
-.then(authCode => {
-  //on success
-  return this.$http.post('http://your-backend-server.com/auth/google', { code: authCode, redirect_uri: 'postmessage' })
-})
-.then(response => {
-  //after ajax
-})
-.catch(error => {
-  //on fail do something
-})
+const authCode = await this.$gAuth.getAuthCode()
+const response = await this.$http.post('http://your-backend-server-api-to-use-authcode', { code: authCode, redirect_uri: 'postmessage' })
 ```
 
-## Usage - Directly get back the `access_token` and `id_token` or use api request
+### Sign-in: Directly get back the `access_token` and `id_token`
 
 ```javascript
-this.$gAuth.signIn()
-.then(GoogleUser => {
-  // On success do something, refer to https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleusergetid
-  console.log('user', GoogleUser)
-  // GoogleUser.getId() : Get the user's unique ID string.
-  // GoogleUser.getBasicProfile() : Get the user's basic profile information.
-  // GoogleUser.getAuthResponse() : Get the response object from the user's auth session. access_token and so on
-  this.isSignIn = this.$gAuth.isAuthorized
-})
-.catch(error  => {
-  //on fail do something
-})
+const googleUser = await this.$gAuth.signIn()
+// googleUser.getId() : Get the user's unique ID string.
+// googleUser.getBasicProfile() : Get the user's basic profile information.
+// googleUser.getAuthResponse() : Get the response object from the user's auth session. access_token and so on
+this.isSignIn = this.$gAuth.isAuthorized
+
 ```
 
 refer to [google signIn reference : GoogleUser](https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleusergetid)
 
 
-## Usage - Sign-out
+### Sign-out
 Handling Google sign-out
 ```javascript
-//you can use promise from v1.1.0 also
-this.$gAuth.signOut()
-.then(() => {
-  // things to do when sign-out succeeds
-})
-.catch(error  => {
-  // things to do when sign-out fails
-})
+const response = await sthis.$gAuth.signOut()
 ```
 
 ## Extra - Directly get `access_token` and `refresh_token` on Server-side
@@ -124,3 +136,11 @@ curl -d "client_id=YOUR_CLIENT_ID&\
 - [Google API Client Libraries : Methods and Classes](https://developers.google.com/api-client-library/javascript/reference/referencedocs)
 - If you are curious of how the entire Google sign-in flow works, please refer to the diagram below
 ![Google Sign-in Flow](http://i.imgur.com/BQPXKyT.png)
+
+
+## FAQ
+### The failure of initialization happens
+You can check the brower console to check errors which occur during initialization.
+The most of errors are from inproper setting of google oauth2 credentials setting in Google Developer Console.
+After changing the settings, you have to do hard refresh to clear your caches.
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-google-oauth2",
-  "version": "1.4.3",
+  "version": "1.5.3",
   "description": "Handling Google Auth2 sign-in and sign-out",
   "main": "index.js",
   "types": "index.ts",