next-auth-client - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

package.json

 {
   "name": "next-auth-client",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "A client for the next-auth module",
@@ -5,0 +5,0 @@ "repository": "https://github.com/iaincollins/next-auth-client.git",

README.md

@@ -1,9 +0,51 @@
-# Next Auth Client
+# NextAuthClient
 
-This a isometric session library for the [next-auth](https://www.npmjs.com/package/next-auth) module.
+## About NextAuthClient
 
-NextAuth is library for adding authentication to Next.js projects.
+NextAuthClient is session library for the [next-auth](https://www.npmjs.com/package/next-auth) module.
 
-## Example usage
+It is only intended to be used in conjuction with [next-auth](https://www.npmjs.com/package/next-auth) in [Next.js](https://github.com/zeit/next.js/) projects.
 
+It exists as a seperate module to reduce the dependancy size.
+
+## Methods
+
+It provides the following methods, all of which return a promise:
+
+### NextAuthClient.init({ req, force })
+
+Isometric (runs client and server side). Return the current session.
+
+When using Server Side Rendering and passed `req` object from **getInitialProps({req})** it will read the data from it.
+
+When using Client Side Rendering it will use localStorage (if avalible) to check for cached session data and if not found or expired it call the `/auth/session` end point.
+
+### NextAuthClient.signin({ email })
+
+Client side only method. Request an email sign in token.
+
+### NextAuthClient.signout()
+
+Client side only method. Triggers the current session to be destroyed.
+
+### NextAuthClient.csrfToken()
+
+Client side only method. Returns the latest CSRF Token.
+
+Note: When rendering server side, this is accessible from NextAuthClient.init().
+
+### NextAuthClient.linked()
+
+Client side only method. Returns a list of linked/unlinked oAuth providers.
+
+This is useful on account management pages where you want to display buttons to link / unlink accounts.
+
+### NextAuthClient.providers()
+
+Client side only method. Returns a list of all configured oAuth providers.
+
+It includes their names, sign in URLs and callback URLs. This is useful on sign in pages and to check the callback URLs when configuring oAuth providers.
+
+## Example
+
 ````javascript
@@ -10,0 +52,0 @@ import React from 'react'

No alert changes

Improved metrics

Total package byte prevSize

36202

increased by4.33%

Number of lines in readme file

79

increased by113.51%

No dependency changes