From d844993503cb04bf368975f2d19a1afc53d8445b Mon Sep 17 00:00:00 2001 From: Lior Kaplan Date: Tue, 2 Jun 2020 22:00:38 +0300 Subject: [PATCH] Shorten README.md Add images Link to milestones instead of static roadmap Move debug info to CONTRIBUTING.md --- README.md | 61 ++++++++----------------------------------------------- 1 file changed, 8 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index ecb051a4..5334b1e3 100644 --- a/README.md +++ b/README.md @@ -5,67 +5,22 @@ Israel's Ministry of Health's COVID-19 exposure prevention app. + + ## Roadmap -### Version 2.0 -#### Improving exposure algorithm: -• Adding user's duration time (t=15 minutes) at certain place
-• Crossing via polygon
-• Bluetooth
-• Changing the Covid-19 patients history locations service from total to incremental
-#### New features: -• Given user's consent, uploading epidemiologically significant locations of confirmed covid19 patients (in research on how to do it in a privacy preserving way)
-• Telemetry, given user's consent
-• Add ability to share the app [#61](https://github.com/MohGovIL/hamagen-react-native/pull/61)
-• IOS: Access to phone locations within the last 14 days by API (in research)
-#### User Experience: -• Externalized the app's version number
-• App is running
-• Adding exposure location on map (point x, point y, radius or by polygon)
-• Differentiation between users who press on "been there" to "not been there". Ability to delete the places the user declare "not been there".
-#### Tests: -• Accessibility tests +See version 2.0 [milestone](https://github.com/MohGovIL/hamagen-react-native/milestone/1) for major issues planned. -### Version 3.0 -• Improving exposure algorithm - by WIFI
-• Translation of covid-19 patient's location
-• Adding manually history locations by the user
-• Improving exposure algorithm - Public transport
-• Delete user's history location from his phone after period of time (configurable) +See version 2.1 [milestone](https://github.com/MohGovIL/hamagen-react-native/milestone/2) for major issues planned. ## Hacking - You're awesome. See [CONTRIBUTING.md](CONTRIBUTING.md). -### Security Measures - +## Security Measures Please review at: https://medium.com/proferosec-osm/hamagen-application-fighiting-the-corona-virus-4ecf55eb4f7c -### Local Database Retrieval - -Make sure your app is [`debuggable`](https://developer.android.com/guide/topics/manifest/application-element). - -~~~ -$ adb exec-out run-as com.hamagen.dev cat databases/Reactoffline.db > app_db.sqlite -~~~ - -## Debug & Release - -Please make sure that you've created a keystore.properties file in your project's root dir with following variables set: - +## License ~~~ -HAMAGEN_KEYSTORE_PATH = '../path/to/release.keystore' -HAMAGEN_STORE_PASSWORD= 'release store password' -HAMAGEN_KEY_ALIAS= 'release key alias' -HAMAGEN_KEY_PASSWORD= 'release key password' - -HAMAGEN_DEBUG_KEYSTORE_PATH = '../path/to/debug.keystore' -HAMAGEN_DEBUG_STORE_PASSWORD= 'debug store password' -HAMAGEN_DEBUG_KEY_ALIAS= 'debug key alias' -HAMAGEN_DEBUG_KEY_PASSWORD= 'debug key password' - +Copyright (c) 2020 Israel's Minsitry of Health ~~~ - -## License - -MIT +This project is licensed under the terms of the MIT license. See the [LICENSE](https://github.com/MohGovIL/hamagen-react-native/blob/master/LICENSE) file.