Skip to content

Commit 18679a1

Browse files
committed
docs: added readme
1 parent d6689bc commit 18679a1

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,48 @@
11
# nuxt-vue3-google-signin
22

3+
[![Build](https://github.com/syetalabs/nuxt-vue3-google-signin/actions/workflows/build.yaml/badge.svg)](https://github.com/syetalabs/nuxt-vue3-google-signin/actions/workflows/build.yaml) [![npm](https://img.shields.io/npm/v/nuxt-vue3-google-signin)](https://www.npmjs.com/package/nuxt-vue3-google-signin) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/nuxt-vue3-google-signin) ![npm](https://img.shields.io/npm/dw/nuxt-vue3-google-signin) ![NPM](https://img.shields.io/npm/l/nuxt-vue3-google-signin) [![Docs](https://img.shields.io/badge/docs-Read%20Now-green)](https://vue3-google-signin.syetalabs.io/)
4+
35
Nuxt Module for [vue3-google-signin](https://vue3-google-signin.syetalabs.io/)
46

7+
## Usage
8+
9+
### Install package
10+
11+
- With **NPM**
12+
13+
```bash
14+
npm install -S nuxt-vue3-google-signin
15+
```
16+
17+
- With **Yarn**
18+
19+
```bash
20+
yarn add nuxt-vue3-google-signin
21+
```
22+
23+
- With **PNPM**
24+
25+
```bash
26+
pnpm add nuxt-vue3-google-signin
27+
```
28+
29+
### Initialize
30+
31+
Now you can add following entry to the `nuxt.config.ts`(or `nuxt.config.js`)
32+
33+
```ts
34+
import { defineNuxtConfig } from 'nuxt'
35+
36+
export default defineNuxtConfig({
37+
modules: [
38+
'nuxt-vue3-google-signin'
39+
],
40+
googleSignIn: {
41+
clientId: 'CLIENT ID OBTAINED FROM GOOGLE API CONSOLE',
42+
}
43+
})
44+
```
45+
546
Checkout [documentation](https://vue3-google-signin.syetalabs.io/) for more.
647

748
## Development

0 commit comments

Comments
 (0)