Merge pull request #128 from enjeck/update-readme

Update Readme

README.md

@@ -2,9 +2,11 @@
 
 ![](https://github.com/securityfirst/Umbrella_android/blob/master/howtouse.gif?raw=true)
 
-Umbrella is a web application developed by [Security First](https://www.secfirst.org) that provides human rights defenders with the information on what to do in any given security situation and the tools to do it. It allows the user to choose what they want to do, such as: protect data; securely make a call/email; securely access the internet; plan secure travel; protect their office/home; conduct counter-surveillance; or deal with kidnapping, arrest or evacuation. Once a situation is chosen, the app outlines what to do and what tools to use given your circumstances. This is followed by a simple checklist of recommended actions that can be customised, saved and shared securely. Umbrella’s dashboard also provides users with an up-to-the-minute account of potential risks in their chosen location.
+Umbrella Web is a web application developed by [Security First](https://www.secfirst.org) that provides human rights defenders with the information on what to do in any given security situation and the tools to do it. It allows the user to choose what they want to do, such as: protect data; securely make a call/email; securely access the internet; plan secure travel; protect their office/home; conduct counter-surveillance; or deal with kidnapping, arrest or evacuation. Once a situation is chosen, the app outlines what to do and what tools to use given your circumstances. This is followed by a simple checklist of recommended actions that can be customised, saved and shared securely. Umbrella’s Feed also provides users with an up-to-the-minute account of potential risks in their chosen location.
 
-## Available on Android
+## Umbrella for Android and iOS
+
+If you don't want to access the Umbrella Web application from a browser, you may download the native iOS or Android application:
 
 <a href="https://play.google.com/store/apps/details?id=org.secfirst.umbrella">
   <img alt="Umbrella on Google Play Store"
@@ -15,47 +17,63 @@ Umbrella is a web application developed by [Security First](https://www.secfirst
 <a href="https://secfirst.org/fdroid/repo">
   <img alt="Umbrella on FDroid"
        src="https://github.com/securityfirst/Umbrella_android/blob/master/FDROID1.png?raw=true" height="80" width="220" /></a href>
+<a href="https://apps.apple.com/us/app/umbrella-security/id1453715310">
+  <img alt="Umbrella on Apple App Store"
+       src="https://github.com/PROTechThor/Umbrella_android/blob/ios-button/APPSTORE1.png?raw=true" height="80" width="220" /></a href>
 
 F-Droid fingerprint: 39EB57052F8D684514176819D1645F6A0A7BD943DBC31AB101949006AC0BC228
 
-## Example Usage
 
-Umbrella is designed for everyone (people looking to increase their security, folks living in high risk areas, regular travellers, business people, techies, journalists, NGO staff, aid workers, human rights defenders, social workers, environmental activists etc).
+## Example Usage
+Umbrella is designed for everyone (people looking to increase their security, folks living in high-risk areas, regular travellers, business people, techies, journalists, NGO staff, aid workers, human rights defenders, social workers, environmental activists, etc).
 
-However, when we built Umbrella we tried to keep in mind the story of Glen Greenwald and Edward Snowden. Greenwald couldn't communicate with Snowden at the start because he found it cumbersome to setup encryption (he nearly missed one of the biggest stories of the decade because of this!). Also, when he (and Laura Poitras) travelled to Hong Kong - they didn't have much knowledge about how to meet securely with Snowden and detect surveillance. This is common problem for journalists and activists. Umbrella is designed to solve this problem (and others) by having nearly everything they would have needed to know in the one place - in their pocket.
+However, when we built Umbrella we tried to keep in mind the story of Glen Greenwald and Edward Snowden. Greenwald couldn't communicate with Snowden at the start because he found it cumbersome to set up encryption (he nearly missed one of the biggest stories of the decade because of this!). Also, when he (and Laura Poitras) travelled to Hong Kong - they didn't have much knowledge about how to meet securely with Snowden and detect surveillance. This is a common problem for journalists and activists. Umbrella is designed to solve this problem (and others) by having nearly everything they would have needed to know in one place - in their pocket.
 
 ## Main Parts of Umbrella
 
 **Introduction:**
 This is the part the user sees first. It explains briefly how the app works and the basic terms and conditions.
 
-**Menu:** The menu is the main way for a user to navigate. It lists the dashboard, lessons and tool guides.
+**Menu:** The bottom navigation menu is the main way for a user to navigate. It lists the feed, forms, lessons (with tool guides), checklists and account.
+
+**Feed:**
+
+![](/FEEDS.png)
 
-**My Security:**
-This where you access checklists you have favourited in "My Checklists" and real time updates in "The Dashboard"
+The feed contains security feeds from places like the UN Relief Web and the US Centers for Disease Control. You enter your location (and how often you want to be updated). Every a new update is released (e.g a disease outbreak in your location), the information comes up on the dashboard.
 
 **Lessons:**
-Lessons are where users can learn about topics and things that they can do to improve their security. Some of the lessons have different levels (Beginner, Advanced, Expert) depending on the your needs, ability and risk. Each lesson is broken down into sections. At the end of each lesson is a list for other resources and further reading.
+
+![](/LESSONS.png)
+
+Lessons are where users can learn about topics and things that they can do to improve their security. Some of the lessons have different levels (Beginner, Advanced, Expert) depending on your needs, ability, and risk. Each module is broken down into sections. At the end of each module is a list of other resources and further reading.
+
+**Tool Guides:** These are detailed guides about how to use software and apps mentioned in the lessons.
 
 **Checklists:**
-Checklists are quick and easy references to help users implement the advice in the lessons. You can tick them off as you complete each item. Items can be added, disabled deleted and edited. If you favourite them by clicking the star, you will then see them in "My Checklists." Checklists can also be shared in through other apps such as your email.
+
+![](/CHECKLISTS.png)
+
+Checklists are quick and easy references to help users implement the advice in the lessons. You can tick them off as you complete each item. Items can be edited. You may also create custom checklists. If you start ticking a checklist, you will then see them on the Checklists page. Checklists can also be shared through other apps such as your email.
 
 **Forms:**
-Forms allow a user to quickly fill out and share important information about issues such as their travel plan in a high risk location or report on a digital/physical security incident.
 
-**Dashboard:**
-The dashboard contains security customFeeds from places like the UN Relief Web and the US Centers for Disease Control. You enter your location (and how often you want to be updated). Every a new update is released (e.g a disease outbreak in your location), the information comes up on the dashboard.
+![](/FORMS.png)
 
-**Tool Guides:**
-These are detailed guides about how to use software and apps mentioned in the lessons.
+Forms allow a user to quickly fill out and share important information about issues such as their travel plan in a high-risk location or report on a digital/physical security incident.
 
 ## Lessons
 
-The general flow of lessons are presented in order to replicate the typical way that a user works. Protecting their own information -> Communicating with other people -> Arranging and travelling to a location -> Doing their operations and work -> Dealing with personal issues that may arise-> Seeking support if something goes wrong.
+The general flow of lessons is presented in order to replicate the typical way that a user works. Protecting their information -> Communicating with other people -> Arranging and travelling to a location -> Doing their operations and work -> Dealing with personal issues that may arise-> Seeking support if something goes wrong.
 
-**_These are the lessons currently in Umbrella._**
+***These are the lessons currently in Umbrella.***
+
+### Access your risk
+
+- Security Planning
+
+### Information
 
-**Information:**
 These lessons mostly cover the security of information that is stored on your computers.
 
 - Managing information
@@ -64,141 +82,123 @@ These lessons mostly cover the security of information that is stored on your co
 - Protecting Files
 - Safely Deleting
 - Backing Up
+- Protect your workplace
+- Workplace raids
+
+### Communications
 
-**Communications:**
 These lessons mostly cover the security of information when it is sent or received.
 
 - Mobile Phones
 - Making a call
 - Sending a message
 - Email
-- The Internet
-- Social Media
-- Radios and Satellite Phones
 
-**Travel:**
-These lessons cover security of travelling in high risk areas.
+### Travel
+
+These lessons cover the security of travelling in high-risk areas.
 
 - Preparation
 - Borders
 - Vehicles
 - Checkpoints
-- Kidnapping
+- Protective Equipment
+
+### Work
 
-**Operations:**
 These lessons include topics that may affect you in your work.
 
 - Meetings
-- Counter-Surveillance
+- Being followed
 - Protests
+- Dangerous Assignments
+- Public Assignments
+- Public Communications
+- Whistleblowers
+
+### Incident Response
+
+These lessons cover how to respond to events. 
+
 - Arrests
 - Evacuation
+- Kidnapping
+- Sexual Assault
+- Terrorism
 
-**Personal:**
-These lessons cover issues which may effect you personally.
+### Stress
 
 - Stress
-- Digital
 
-**Emergency Support:**
+### Emergency Support
+
 Explains places to get extra help if you have a problem.
 
 - Physical
 - Digital
 
-## Tools
-
-These are the tools currently covered in the tool guide. (A number of them are due to be changed, removed or updated.)
-
-- Adium
-- Android
-- Chatsecure
-- Cobian Backup
-- Facebook
-- K9 Mail & APG
-- KeePassX
-- ObscuraCam
-- Orbot & Orweb
-- PGP for Linux
-- PGP for Mac OS X
-- PGP for Windows
-- Pidgin
-- Psiphon
-- Rescuva
-- Signal
-- Tor for macOS
-- Tor for Windows
-- VeraCrypt
-
+### Tools
+
+These are detailed guides about how to use software and apps mentioned in the lessons. These are the tools currently covered in the tool guide.
+
+- Messaging
+    * Mailvelope
+    * ObscuraCam
+    * Pidgin
+    * Psiphon
+    * Signal for Android
+    * Signal for iOS
+- Encryption
+    * Encrypt your iPhone
+    * k9 & Open Keychain
+    * KeePasXC
+- PGP
+    * PGP for Linux
+    * PGP for MacOS
+    * PGP for Windows
+- Tor
+    * Orbot & Orfox
+    * Tor for MacOS
+    * Tor for Linux
+    * Tor for Windows
+- Files
+    * Cobian Backup
+    * Recuva
+    * VeraCrypt
+- Other
+    * Android
+    * Facebook
 ## Glossary
-
 Contains explanations of the various terms used in the app.
 
 ## About
-
 Explains the licences that we use for and by Umbrella. Also says a big THANKYOU to everyone who's work we built on to make it happen.
 
 ## Dashboard Feed Sources
+![](https://github.com/securityfirst/Umbrella_android/blob/master/DASHBOARDLOGOS.png)
 
-![](https://github.com/rorymbyrne/Umbrella_android/blob/master/DASHBOARDLOGOS.png?raw=true)
-
-These are the sources that we currently include for real-time updated security customFeeds. For privacy reasons, users never connect directly to these services. We are always looking for more useful sources that will help users keep updated on the move.
-
-- [Centers for Disease Control](https://www.cdc.gov): updates on disease and health warnings
-- [Global Disaster Alert and Coordination System](http://www.gdacs.org): updates on natural disaster issues such as floods, earthquakes and tsunamis
-- [UN / ReliefWeb](http://reliefweb.int): excellent physical security updates that amalgamate information from the UN and various NGOs - though not available in every country
-- [US State Department](https://www.state.gov/travel/): updates mainly focused on the security situation for travellers and internationals - available for every country
+These are the sources that we currently include for real-time updated security Feeds. For privacy reasons, users never connect directly to these services. We are always looking for more useful sources that will help users keep updated on the move.
+* [ReliefWeb / UN](http://reliefweb.int): excellent physical security updates that amalgamate information from the UN and various NGOs - though not available in every country
+* [Foreign and Commonwealth Office](https://www.gov.uk/government/organisations/foreign-commonwealth-office): foreign travel advice, consular help and services abroad and document legislation
+* [Centers for Disease Control](https://www.cdc.gov): updates on disease and health warnings
+* [Global Disaster Alert and Coordination System](http://www.gdacs.org): updates on natural disaster issues such as floods, earthquakes and tsunamis
+* [US State Department Country Warnings](https://www.state.gov/travel/): updates mainly focused on the security situation for travellers and internationals - available for every country
 
-## Settings
+## Account
+Navigate to the "Account" from the menu on th left of the screen. Here you can:
 
-The three vertical dots in the top of the app. Here you can:
-
-- Set a password
-- Change the refresh interval for the security customFeeds
-- Change your location
-- Change your feed sources
+* Modify settings (feed interval, feed location, feed sources, notifications, connections, import data, export data)
+* Enable Mask
+* Set a password
+* Log out
 
 ## Requirements
 
 Any browser on any device!
 
-## Contributing Bug reports
-
-Unfortunately stuff breaks sometimes. If you are in a hurry and have found a code or content problem then please email it to <support@secfirst.org>. If you have a little more time we generally try to manage any bugs using GitHub. Please search the existing issues for your bug and create a new one if the issue is not yet tracked.
-
-<https://github.com/securityfirst/Umbrella_web/issues>
-
-If the issue you have identified is a security risk to users, please
-read the documentation about our responsible disclosure policy here:
-
-<https://secfirst.org/legal.html>
-
-If you wish to contact us via PGP, please drop a mail to
-<rory@secfirst.org> (2C1D3B4D)
-
-<https://pgp.mit.edu/pks/lookup?op=vindex&search=0xFFB9B5BE2C1D3B4D>
-
-**Contributing Ideas**
-
-Idea’s are powerful things! If you have any about what we could do
-better or things which you think we should do in future, please email us
-at <info@secfirst.org>.
-
-## Contributing Code
-
-We have a really big development plan of functionality we want to
-include in the future and are currently in the process of building a way
-to manage contributions from the open source community. Until we have
-that up please drop us a mail to <info@secfirst.org> if you are
-interested in a contributing a specific part of future code. If there is
-something you want to help out with in the interim, then here is some
-basic advice.
+## Contributing
 
-1.  Fork it!
-2.  Create your feature branch: git checkout -b my-new-feature
-3.  Commit your changes: git commit -am 'Add some feature'
-4.  Push to the branch: git push origin my-new-feature
-5.  Submit a pull request :D
+Thank you for your interest in contributing to Umbrella. See our [contributing guide](https://secfirst.org/contribute/).
 
 **Build Instructions**
 
@@ -242,7 +242,7 @@ information.
 
 **License**
 
-Copyright 2013-2018 Global Security First Ltd. (trading as Security
+Copyright 2013-2021 Global Security First Ltd. (trading as Security
 First)
 
 Licensed under the