Permalink
Browse files

Updates Readme, Cleans up settings.gradle file

  • Loading branch information...
1 parent af64278 commit 6cd84f74f447a0a29d8513c1adcc9277e6bbcc75 @piyushgupta27 piyushgupta27 committed May 12, 2017
Showing with 13 additions and 13 deletions.
  1. +12 −10 README.md
  2. +1 −3 settings.gradle
View
@@ -22,11 +22,18 @@ Your location and trips are completely private and secure. They are shared only
## Usage
1. Clone the project.
-2. Get HyperTrack API keys. Learn more about them [here](https://docs.hypertrack.com/gettingstarted/authentication.html), and sign up for them [here](https://dashboard.hypertrack.com/signup).
+2. Get your HyperTrack API keys [here](https://dashboard.hypertrack.com/signup), and add the publishable key to [gradle.properties](https://github.com/hypertrack/hypertrack-live-android/blob/master/gradle.properties) file. To get to know more about API keys, refer to the [Authentication](https://docs.hypertrack.com/gettingstarted/authentication.html) section in our documentation.
3. Get [Google Map API Key](https://developers.google.com/maps/documentation/android-api/signup) and add them to the AndroidManifest.xml.
-4. Add publishable key to hypertrackkey.properties file [here](https://github.com/hypertrack/hypertrack-live-android/blob/master/hypertrackkey.properties).
-5. Check out the [Live Location Sharing tutorial](https://www.hypertrack.com/tutorials/live-location-sharing-android-messaging-app) and the [Service Visit Tracking tutorial](https://www.hypertrack.com/tutorials/service-visit-tracking-android) for a few suggestions of how to use this source code in your business.
-
+4. HyperTrack SDKs require FCM/GCM integration for enhanced realtime tracking experiences. Refer to our [FCM Integration guide](https://docs.hypertrack.com/sdks/android/guides/gcm-integration.html) for detailed info. Once you have either an existing account on [Google Developer](https://console.developers.google.com/) or a new account [Firebase console](https://console.firebase.google.com), you will need to add [google-services.json](https://support.google.com/firebase/answer/7015592) file for your app to remove the below compilation failure.
+
+ > Error:Execution failed for task ':app:processDebugGoogleServices'.
+ > File google-services.json is missing. The Google Services Plugin cannot function without it.
+ > Searched Location:
+ > /Users/piyush/StudioProjects/hypertrack-live-android/app/src/debug/google-services.json
+ > /Users/piyush/StudioProjects/hypertrack-live-android/app/google-services.json
+
+**Check out the [Live Location Sharing tutorial](https://www.hypertrack.com/tutorials/live-location-sharing-android-messaging-app) and the [Service Visit Tracking tutorial](https://www.hypertrack.com/tutorials/service-visit-tracking-android) for a few suggestions of how to use this source code in your business.**
+
## Documentation
For detailed documentation of the methods and customizations, please visit the official [HyperTrack Docs](https://docs.hypertrack.com/).
@@ -38,13 +45,8 @@ Join our [Slack community](http://slack.hypertrack.com) for instant responses, o
## Dependencies
* [Google v7 appcompat library](https://developer.android.com/topic/libraries/support-library/packages.html#v7-appcompat)
-* [Google v7 cardview library](https://developer.android.com/topic/libraries/support-library/packages.html#v7-cardview)
-* [Google v7 recyclerview library](https://developer.android.com/topic/libraries/support-library/packages.html#v7-cardview)
* [Google Design Support Library](https://developer.android.com/topic/libraries/support-library/packages.html#design)
* [Google libphonenumber library](https://github.com/googlei18n/libphonenumber/)
* [Square Retrofit](https://github.com/square/retrofit)
* [Square Picasso](https://github.com/square/picasso)
-* [tajchert WaitingDots](https://github.com/tajchert/WaitingDots)
-* Google Play Services - GCM
-* Google Play Services - Places
-* Google Play Services - Location
+* [tajchert WaitingDots](https://github.com/tajchert/WaitingDots)
View
@@ -1,3 +1 @@
-include ':app'
-include ':library'
-project(':library').projectDir = new File(settingsDir, '../hypertrack-android-v2/library')
+include ':app'

0 comments on commit 6cd84f7

Please sign in to comment.