piral-auth - npm Package Compare versions

Comparing version 0.8.3 to 0.9.0-pre.739

package.json

		{
		"name": "piral-auth",
		"version": "0.8.3",
		"version": "0.9.0-pre.739",
		"description": "Extensions for handling authentication in Piral.",
		@@ -39,3 +39,3 @@ "keywords": [
		"devDependencies": {
		"piral-core": "^0.8.3"
		"piral-core": "^0.9.0-pre.739"
		},
		@@ -45,3 +45,3 @@ "peerDependencies": {
		},
		"gitHead": "0e031b4cad4c255dfde11f5f62dbc27160f26f08"
		"gitHead": "92414f91e86075e1bddcfcb3f838a61fee60888e"
		}

README.md

		@@ -5,8 +5,14 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io)

		This is an extension library that only has a peer dependency to `piral-core`. What `piral-auth` brings to the table is a set of API extensions that can be used with `piral` or `piral-core`. By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. The set includes the `getUser` API to retrieve the user, login / logout functionality and user state management incl. features and permissions.
		This is an extension library that only has a peer dependency to `piral-core`. What `piral-auth` brings to the table is a set of API extensions that can be used with `piral` or `piral-core`.

		By default, these extensions are not integrated in `piral`, so you'd need to add them to your Piral instance. The set includes the `getUser` API to retrieve the user, login / logout functionality and user state management incl. features and permissions.

		## Documentation

		For details on the provided API check out the [documentation at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/master/docs).
		The following functions are brought to the Pilet API.

		### `getUser()`

		Gets the currently authenticated user or `undefined` if no user is authenticated.

		## Setup and Bootstrapping
		@@ -13,0 +19,0 @@

New alerts