Skip to content
This repository was archived by the owner on Jun 10, 2022. It is now read-only.

Commit 570da8e

Browse files
nikolaseunikolaseu
committed
Update README
1 parent f8f3320 commit 570da8e

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

‎README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
# react-native-lock-android
22

3+
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat)](http://doge.mit-license.org)
34
[![NPM version][npm-image]][npm-url]
4-
[![CI Status][travis-image]][travis-url]
5+
[![CI Status][travis-image-android]][travis-url-android]
56

67
[Auth0](https://auth0.com) is an authentication broker that supports social identity providers as well as enterprise identity providers such as Active Directory, LDAP, Google Apps and Salesforce.
78

8-
**react-native-lock-android** is a wrapper around [Lock](https://github.com/auth0/Lock.Android) so it can be used from an Android React Native application
9+
**react-native-lock-android** is a wrapper around [Lock.Android](https://github.com/auth0/Lock.Android) so it can be used from an Android React Native application
10+
911

1012
## Requirements
1113

12-
* Android API 16+
1314
* React Native
15+
* Android API 16+
16+
1417

1518
## Installation
1619

1720
Run `npm install --save react-native-lock-android` to add the package to your app's dependencies.
1821

19-
Then add the dependency in the `build.gradle` file of the android project:
22+
You need to include the `com.auth0.android:lock-react-native` library in your android project.
23+
Add the dependency in the `build.gradle` file of the android project:
2024

2125
```gradle
2226
compile 'com.auth0.android:lock-react-native'
@@ -44,6 +48,7 @@ public class MainActivity extends Activity implements DefaultHardwareBackBtnHand
4448

4549
Finally you should see the Lock.Android [docs](https://github.com/auth0/Lock.Android) to find out how to add the Lock activities to your `AndroidManifest.xml` file.
4650

51+
4752
## Usage
4853

4954
Let's require `react-native-lock-android` module:
@@ -68,7 +73,8 @@ lock.show({}, (err, profile, token) => {
6873

6974
And you'll see our native login screen
7075

71-
[![Lock.png](https://cdn.auth0.com/mobile-sdk-lock/lock-android-default.png)](https://auth0.com)
76+
[![Lock.png](http://blog.auth0.com.s3.amazonaws.com/Lock-Widget-Android-Screenshot.png)](https://auth0.com)
77+
7278

7379
### SMS Passwordless
7480

@@ -81,7 +87,8 @@ lock.show({
8187
```
8288
And you'll see SMS Passwordless login screen
8389

84-
[![Lock.png](https://cdn.auth0.com/mobile-sdk-lock/lock-android-pwdless-sms.png)](https://auth0.com)
90+
[![Lock.png](http://blog.auth0.com.s3.amazonaws.com/Lock-SMS-Android-Screenshot.png)](https://auth0.com)
91+
8592

8693
### Email Passwordless
8794

@@ -94,7 +101,8 @@ lock.show({
94101
```
95102
And you'll see Email Passwordless login screen
96103

97-
[![Lock.png](https://cdn.auth0.com/mobile-sdk-lock/lock-android-pwdless-email.png)](https://auth0.com)
104+
[![Lock.png](https://cdn.auth0.com/mobile-sdk-lock/lock-ios-pwdless-email.png)](https://auth0.com)
105+
98106

99107
## API
100108

@@ -141,5 +149,5 @@ react-native-lock-android is available under the MIT license. See the [LICENSE f
141149
<!-- Variables -->
142150
[npm-image]: https://img.shields.io/npm/v/react-native-lock-android.svg?style=flat
143151
[npm-url]: https://npmjs.org/package/react-native-lock-android
144-
[travis-image]: http://img.shields.io/travis/auth0/react-native-lock-android.svg?style=flat
145-
[travis-url]: https://travis-ci.org/auth0/react-native-lock-android
152+
[travis-image-android]: http://img.shields.io/travis/auth0/react-native-lock-android.svg?style=flat
153+
[travis-url-android]: https://travis-ci.org/auth0/react-native-lock-android

0 commit comments

Comments
 (0)