Skip to content

Commit 9b29af6

Browse files
authored
Update README.md
1 parent 97dbfe0 commit 9b29af6

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
A component used to authenticate with Netlify's Identity service.
44
[Live demo](https://identity.netlify.com)
55

6-
If you want direct, "widgetless" access to Netlify Identity authentication that uses a popup window instead of a redirect, try [`netlify-auth-providers`](https://github.com/netlify/netlify-auth-providers). You can also implement your own authentication endpoints with Netlify Functions, locally developed in [`netlify-lambda`](https://github.com/netlify/netlify-lambda/).
7-
8-
For a lower level library to the underlying [GoTrue](https://github.com/netlify/gotrue) API, see
9-
[gotrue-js](https://github.com/netlify/gotrue-js).
10-
116
For usage example with React and React Router, please see our `/example` folder and [read the README](https://github.com/netlify/netlify-identity-widget/tree/master/example).
127

138
## What is Netlify Identity
@@ -159,6 +154,17 @@ https://olddvdscreensaver.com
159154

160155
![](devmode.png)
161156

157+
158+
## List of Alternatives
159+
160+
**Lowest level JS Library**: If you want to use the official Javascript bindings to GoTrue, Netlify's underlying Identity service written in Go, use https://github.com/netlify/gotrue-js
161+
162+
**React bindings**: If you want a thin wrapper over Gotrue-js for React, `react-netlify-identity` is a "headless" library, meaning there is no UI exported and you will write your own UI to work with the authentication. https://github.com/sw-yx/react-netlify-identity
163+
164+
**High level overlay**: If you want a "widget" overlay that gives you a nice UI out of the box, with a somewhat larger bundle, check https://github.com/netlify/netlify-identity-widget
165+
166+
**High level popup**: If you want a popup window approach also with a nice UI out of the box, and don't mind the popup flow, check https://github.com/netlify/netlify-auth-providers
167+
162168
## FAQ
163169

164170
* Typescript Typings are maintained by @nkprince007 ([see PR](https://github.com/DefinitelyTyped/DefinitelyTyped/pull/30689)): `npm install @types/netlify-identity-widget` and then `import * as NetlifyIdentityWidget from "netlify-identity-widget"` (or `import NetlifyIdentityWidget from "netlify-identity-widget"` if you have `--allowSyntheticDefaultImports` on)

0 commit comments

Comments
 (0)