Skip to content

Commit 857a83f

Browse files
wangmengyan95wangmengyan95
committed
Update README.md
1 parent 946baed commit 857a83f

File tree

1 file changed

+20
-71
lines changed

1 file changed

+20
-71
lines changed

‎README.md‎

Lines changed: 20 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,35 @@
1-
# ParseUI
2-
## Overview
3-
This project contains the `ParseLoginUI` library for building login and signup flows with the Parse Android SDK.
4-
You can easily configure the look and feel of the login screens by either specifying XML configurations or constructing an Intent in code.
5-
To use this project with your app, you should import it as a library project in Android Studio.
1+
# Parse SDK for Android
62

7-
![sample screens](http://parseui-android.parseapp.com/images/parse_login_sample_screens.png)
3+
This project contains two libraries, `ParseUI-Login` and `ParseUI-Widget`.
84

9-
### Getting Started
10-
We built several sample apps demonstrating how to use the `ParseLoginUI` library. Before importing
11-
this library into your app, we recommend that you run these sample apps to become familiar with its
12-
functionality and customizations. In this section, we describe Android Studio instructions for
13-
running the sample apps (as a standalone project), and importing the `ParseLoginUI` library into
14-
your own app. These instructions were last tested on Android Studio 1.1.0.
5+
The `ParseUI-Login` library is used for building login and signup flows with the Parse Android SDK. You can easily configure the look and feel of the login screens by either specifying XML configurations or constructing an Intent in code.
156

16-
#### Running Sample Projects
17-
To run our sample apps, you need to import this repo as a standalone Gradle project:
7+
The `ParseUI-Widget` library provides several useful UI widgets which integrate with `ParseObject` seamlessly.
188

19-
1. Clone this repository onto your machine.
20-
2. Import this repository's project with Android Studio (File > Import Project > `ParseUI-Android` folder). The project has Maven dependencies on the Facebook SDK and the Bolts framework. Android Studio automatically resolves these via Gradle.
21-
3. Specify the following in `res/values/strings.xml` of each sample project:
22-
* <code>parse_app_id</code> and <code>parse_client_key</code>
23-
* <code>facebook_app_id</code>
24-
* <code>twitter_consumer_key</code> and <code>twitter_consumer_secret</code>
25-
4. Build (Tools > Android > Sync Project with Gradle Files) and run the sample apps using Android Studio.
269

27-
#### Importing into Your App
10+
## Import to your project
2811
1. Clone this repository onto your machine.
2912
2. Configure Parse SDK by following this [tutorial](https://www.parse.com/apps/quickstart#parse_data/mobile/android/native/existing).
30-
3. Import `ParseLoginUI` as a module into your app's Android Studio Project
13+
3. Import `ParseUI-Login` and `ParseUI-Widget` as modules into your app's Android Studio Project
3114
* File > Import Module in Android Studio
32-
* In the New Module pop-up, set the source directory to the `ParseUI-Android/ParseLoginUI` folder within the cloned repo.
33-
15+
* In the New Module pop-up, set the source directory to the `ParseUI-Android/ParseUI-Login` and `ParseUI-Android/ParseUI-Widget` folder within the cloned repo.
3416
4. Add the following to the `dependencies` section of your app's build.gradle.
3517

36-
// Module dependency on ParseLoginUI library sources
37-
compile project(':ParseLoginUI')
38-
39-
// Uncomment if using Facebook Login (optional Maven dependency)
40-
// compile 'com.facebook.android:facebook-android-sdk:4.0.1'
41-
// compile files('YOUR_PROJECT_LIBS_PATH/ParseFacebookUtilsV4-1.10.0.jar')
42-
43-
5. Add the following to your `AndroidManifest.xml` within the `<application></application>` section. You can see a complete example in our [sample app](https://github.com/ParsePlatform/ParseUI-Android/blob/master/ParseLoginSampleBasic/src/main/AndroidManifest.xml).
44-
45-
<activity
46-
android:name="com.parse.ui.ParseLoginActivity"
47-
android:label="@string/app_name"
48-
android:launchMode="singleTop">
49-
<!-- For more options, see https://www.parse.com/docs/android_guide#ui-login -->
50-
<meta-data
51-
android:name="com.parse.ui.ParseLoginActivity.PARSE_LOGIN_ENABLED"
52-
android:value="true"/>
53-
<meta-data
54-
android:name="com.parse.ui.ParseLoginActivity.PARSE_LOGIN_EMAIL_AS_USERNAME"
55-
android:value="true"/>
56-
</activity>
57-
58-
6. Specify the following in `res/values/strings.xml` of your app
18+
```grovvy
19+
// Module dependency on ParseUI libraries sources
20+
compile project(':ParseUI-Login')
21+
compile project(':ParseUI-Widget')
5922
60-
<string name="parse_app_id">YOUR_PARSE_APP_ID</string>
61-
<string name="parse_client_key">YOUR_PARSE_CLIENT_KEY</string>
23+
// Uncomment if using Facebook Login (optional Maven dependency)
24+
// compile 'com.facebook.android:facebook-android-sdk:4.0.1'
25+
// compile files('YOUR_PROJECT_LIBS_PATH/ParseFacebookUtilsV4-1.10.0.jar')
26+
```
6227
63-
For an example of setting up Facebook and Twitter integrations, please see `AndroidManfest.xml` and `res/values/strings.xml` in our [sample app](https://github.com/ParsePlatform/ParseUI-Android/blob/master/ParseLoginSampleBasic).
28+
## Usage
29+
Please check the tutorial in our [wiki](https://github.com/ParsePlatform/ParseUI-Android/wiki);
6430
6531
## Documentation
6632
For complete details about this library project, please see our [documentation](https://www.parse.com/docs/android/guide#user-interface-parseloginui) on the Parse website.
67-
We'll discuss some highlights here.
68-
69-
To start the login flow from your own activity, you launch the `ParseLoginActivity` with two lines of code:
70-
71-
```java
72-
ParseLoginBuilder builder = new ParseLoginBuilder(MyActivity.this);
73-
startActivityForResult(builder.build(), 0);
74-
```
75-
76-
`ParseLoginActivity` will guide the user through the login experience, where the user can also sign up or reset a forgotten password.
77-
Each screen in the login experience is implemented by a fragment hosted within this activity.
78-
When `ParseLoginActivity` finishes, you can check `ParseUser.getCurrentUser()` in your own activity to see whether the user actually logged in.
79-
80-
This library is ultra-customizable, allowing you to configure the login experience through either XML or code.
81-
As shown in the Getting Started section, you can directly configure the login experience through the activity
82-
meta-data in `AndroidManifest.xml`.
83-
84-
Please see the [Parse website](https://www.parse.com/docs/android/guide#user-interface-parseloginui) for additional documentation.
8533
8634
## Contributing
8735
See the CONTRIBUTING file for how to help out.
@@ -94,12 +42,13 @@ copy, modify, and distribute this software in source code or binary form for use
9442
in connection with the web services and APIs provided by Parse.
9543
9644
As with any software that integrates with the Parse platform, your use of
97-
this software is subject to the [Parse Terms of Service](https://www.parse.com/about/terms). This copyright notice shall be
45+
this software is subject to the [Parse Terms of Service]
46+
(https://www.parse.com/about/terms). This copyright notice shall be
9847
included in all copies or substantial portions of the software.
9948
10049
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10150
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
10251
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
10352
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
10453
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
105-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
54+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)