146146 < section class ="readme ">
147147 < article >
148148 < h1 > react-native-auth0</ h1 >
149+ < p >
150+ React Native toolkit for Auth0 API, compliant with
151+ < a href ="https://tools.ietf.org/html/rfc8252 "> RFC 8252</ a >
152+ </ p >
149153 < p >
150154 < a href ="https://circleci.com/gh/auth0/react-native-auth0 "
151155 > < img
@@ -173,10 +177,50 @@ <h1>react-native-auth0</h1>
173177 alt ="Downloads "
174178 /> </ a >
175179 </ p >
176- < p >
177- React Native toolkit for Auth0 API, compliant with
178- < a href ="https://tools.ietf.org/html/rfc8252 "> RFC 8252</ a >
179- </ p >
180+ < h2 > Table of Contents</ h2 >
181+ < ul >
182+ < li > < a href ="#documentation "> Documentation</ a > </ li >
183+ < li > < a href ="#requirements "> Requirements</ a > </ li >
184+ < li > < a href ="#getting-started "> Getting Started</ a > </ li >
185+ < li > < a href ="#usage "> Usage</ a > </ li >
186+ < li > < a href ="#support--feedback "> Support + Feedback</ a > </ li >
187+ < li >
188+ < a href ="#vulnerability-reporting "> Vulnerability Reporting</ a >
189+ </ li >
190+ < li > < a href ="#thank-you "> Thank You</ a > </ li >
191+ < li > < a href ="#what-is-auth0 "> What is Auth0</ a > </ li >
192+ < li > < a href ="#license "> License</ a > </ li >
193+ </ ul >
194+ < h2 > Documentation</ h2 >
195+ < ul >
196+ < li >
197+ The
198+ < a href ="https://auth0.com/docs/quickstart/native/react-native "
199+ > React Native Quickstart</ a
200+ >
201+ shows how to get an iOS or Android app running from scratch.
202+ </ li >
203+ < li >
204+ The
205+ < a
206+ href ="https://github.com/auth0-samples/auth0-react-native-sample/tree/master/00-Login "
207+ > React Native Sample</ a
208+ >
209+ has complete, running iOS and Android applications you can try.
210+ </ li >
211+ < li >
212+ The < a href ="#usage "> Usage</ a > section below covers specific use
213+ cases outside of basic authentication.
214+ </ li >
215+ < li >
216+ The
217+ < a href ="https://auth0.github.io/react-native-auth0/ "
218+ > API documentation</ a
219+ >
220+ is generated from the code and explains all methods that are able
221+ to be used.
222+ </ li >
223+ </ ul >
180224 < h2 > Requirements</ h2 >
181225 < p >
182226 This SDK targets apps that are using React Native SDK version
@@ -216,7 +260,7 @@ <h3>Compatibility Matrix</h3>
216260 > branch v1</ a
217261 > .
218262 </ p >
219- < h2 > Getting started </ h2 >
263+ < h2 > Getting Started </ h2 >
220264 < p > First install the native library module:</ p >
221265 < p > Using < a href ="https://www.npmjs.com "> npm</ a > </ p >
222266 < p > < code > $ npm install react-native-auth0 --save</ code > </ p >
@@ -554,71 +598,77 @@ <h3>Get full user profile</h3>
554598 > documentation</ a
555599 >
556600 </ p >
557- < h2 > What is Auth0?</ h2 >
558- < p > Auth0 helps you to:</ p >
601+ < h2 > Contributing</ h2 >
602+ < p >
603+ We appreciate feedback and contribution to this repo! Before you get
604+ started, please see the following:
605+ </ p >
559606 < ul >
560607 < li >
561- Add authentication with
562- < a href ="https://docs.auth0.com/identityproviders "
563- > multiple authentication sources</ a
564- > , either social like
565- < strong
566- > Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter,
567- Box, Salesforce, amont others</ strong
568- > , or enterprise identity systems like
569- < strong
570- > Windows Azure AD, Google Apps, Active Directory, ADFS or any
571- SAML Identity Provider</ strong
572- > .
573- </ li >
574- < li >
575- Add authentication through more traditional
576- < strong
577- > < a href ="https://docs.auth0.com/mysql-connection-tutorial "
578- > username/password databases</ a
579- > </ strong
580- > .
608+ < a
609+ href ="https://github.com/auth0/.github/blob/master/CONTRIBUTING.md "
610+ > Auth0's general contribution guidelines</ a
611+ >
581612 </ li >
582613 < li >
583- Add support for
584- < strong
585- > < a href ="https://docs.auth0.com/link-accounts "
586- > linking different user accounts</ a
587- > </ strong
614+ < a
615+ href ="https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md "
616+ > Auth0's code of conduct guidelines</ a
588617 >
589- with the same user.
590618 </ li >
619+ < li > < a href ="DEVELOPMENT.md "> This repo's development guide</ a > </ li >
620+ </ ul >
621+ < h2 > Support + Feedback</ h2 >
622+ < ul >
591623 < li >
592- Support for generating signed
593- < a href ="https://docs.auth0.com/jwt "> Json Web Tokens</ a > to call
594- your APIs and < strong > flow the user identity</ strong > securely.
624+ Use
625+ < a href ="https://github.com/auth0/react-native-auth0/issues "
626+ > Issues</ a
627+ >
628+ for code-level support
595629 </ li >
596- < li > Analytics of how, when and where users are logging in.</ li >
597630 < li >
598- Pull data from other sources and add it to the user profile,
599- through
600- < a href ="https://docs.auth0.com/rules "> JavaScript rules</ a > .
631+ Use < a href ="https://community.auth0.com/ "> Community</ a > for
632+ usage, questions, specific cases
601633 </ li >
602634 </ ul >
603- < h2 > Create a free Auth0 Account</ h2 >
604- < ol >
605- < li >
606- Go to < a href ="https://auth0.com "> Auth0</ a > and click Sign Up.
607- </ li >
608- < li > Use Google, GitHub or Microsoft Account to login.</ li >
609- </ ol >
610- < h2 > Issue Reporting</ h2 >
635+ < h2 > Vulnerability Reporting</ h2 >
611636 < p >
612- If you have found a bug or if you have a feature request, please
613- report them at this repository issues section. Please do not report
614- security vulnerabilities on the public GitHub issue tracker. The
615- < a href ="https://auth0.com/whitehat "
637+ Please do not report security vulnerabilities on the public GitHub
638+ issue tracker. The
639+ < a href ="https://auth0.com/responsible-disclosure-policy/ "
616640 > Responsible Disclosure Program</ a
617641 >
618642 details the procedure for disclosing security issues.
619643 </ p >
620- < h2 > Author</ h2 >
621- < p > < a href ="auth0.com "> Auth0</ a > </ p >
644+ < h2 > What is Auth0?</ h2 >
645+ < p > Auth0 helps you to easily:</ p >
646+ < ul >
647+ < li >
648+ implement authentication with multiple identity providers,
649+ including social (e.g., Google, Facebook, Microsoft, LinkedIn,
650+ GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD,
651+ Google Apps, Active Directory, ADFS, SAML, etc.)
652+ </ li >
653+ < li >
654+ log in users with username/password databases, passwordless, or
655+ multi-factor authentication
656+ </ li >
657+ < li > link multiple user accounts together</ li >
658+ < li >
659+ generate signed JSON Web Tokens to authorize your API calls and
660+ flow the user identity securely
661+ </ li >
662+ < li >
663+ access demographics and analytics detailing how, when, and where
664+ users are logging in
665+ </ li >
666+ < li >
667+ enrich user profiles from other data sources using customizable
668+ JavaScript rules
669+ </ li >
670+ </ ul >
671+ < p > < a href ="https://auth0.com/why-auth0 "> Why Auth0?</ a > </ p >
622672 < h2 > License</ h2 >
623673 < p >
624674 This project is licensed under the MIT license. See the
@@ -633,7 +683,7 @@ <h2>License</h2>
633683
634684 < footer >
635685 Generated by < a href ="https://github.com/jsdoc3/jsdoc "> JSDoc 3.6.3</ a > on
636- Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
686+ Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
637687 Minami theme.
638688 </ footer >
639689
0 commit comments