diff --git a/README.md b/README.md index 113fa6c..1fd41e4 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ -# aws-amplify-auth-ui-kitten \ No newline at end of file +# AWS-Amplify-Auth-UI-Kitten + +[UI Kitten](https://github.com/akveo/react-native-ui-kitten) implementation fro [AWS Amplify](https://github.com/aws-amplify/amplify-js) authentication UI. + +[![NPM](https://nodei.co/npm/aws-amplify-auth-ui-kitten.png?compact=true)](https://nodei.co/npm/aws-amplify-auth-ui-kitten/) + +## Prerequisites + +- Install UI Kitten, see [documentation](https://akveo.github.io/react-native-ui-kitten/docs/guides/getting-started#getting-started) +- Install and configure AWS Amplify Authetication for react native, see [documentation](https://docs.amplify.aws/start/q/integration/react-native) + +## Install + +`yarn add aws-amplify-auth-ui-kitten` + +## How to use + +``` +import { SignIn, SignUp, ConfirmSignUp, ConfirmSignIn, ForgotPassword, RequireNewPassword } from 'aws-amplify-auth-ui-kitten'; +import { Authenticator } from 'aws-amplify-react-native'; + +export default () => { + const [authState, setAuthState] = useState() + + return ( + <> + + + {authState === 'signedIn' ? () : ( + + + + + + + + + )} + + + ) +} +``` + +## License +[MIT](LICENSE) license. + +--- +Made with ❤️ by [MEOM](https://www.meom.fi) \ No newline at end of file