diff --git a/README.md b/README.md index e10a6604..d4a8dc58 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,15 @@ -## comma Connect - React Native App +## comma connect + +This is a React Native App to connect your phone to your vehicles equipped with [comma two](https://comma.ai/shop/products/comma-two-devkit) or [EON](https://comma.ai/shop/products/eon-gold-dashcam-devkit). + +Pair your `comma two` for: + +- Real-time vehicle location on the map (for devices connected to Internet, with software version 0.5.10 or newer) +- Live snapshot from device cameras (for devices connected to Internet, with software version 0.7 or newer) +- Drive videos replay with GPS path (also available [on the website and offline](https://github.com/commaai/openpilot/tree/master/tools#replay-driving-data)) +- 24/7 device connectivity when subscribed to `comma prime` (free 3-month trial, can be activated without the data plan if you have a third-party SIM) + +See also: [Frequently Asked Questions](https://comma.ai/faq) ### Install - `git clone https://github.com/commaai/connect.git` @@ -6,26 +17,29 @@ - `bundle install` - `yarn` +### Run + +#### Run Android Debug (Device/Simulator) +- `yarn android` + #### Run iOS Debug (Simulator) - `cd ios && bundle install && pod install` - `cd ..` - `yarn ios` -#### Run Android Debug (Device/Simulator) -- `yarn android` +### Release -#### Release Android beta +#### Android beta release - `KEYSTORE_PASSWORD=*** bundle exec fastlane android internal_beta` -- visit play store releases dashboard to finalize release (only if gradle versionName changes) +- visit [Play Store releases dashboard](https://play.google.com/apps/publish/) to finalize release (only if gradle versionName changes) -#### Release iOS beta +#### iOS beta release - `bundle exec fastlane ios beta` #### Android production release - `KEYSTORE_PASSWORD=*** bundle exec fastlane android production` -- visit play store releases dashboard to finalize release +- visit [Play Store releases dashboard](https://play.google.com/apps/publish/) to finalize release #### iOS production release - `bundle exec fastlane ios production` -- visit https://appstoreconnect.apple.com/ to finalize release - +- visit [App Store Connect](https://appstoreconnect.apple.com/) to finalize release