Skip to content

Commit f7f80da

Browse files
committed
Update README.md
1 parent 703bd92 commit f7f80da

File tree

8 files changed

+45
-21
lines changed

8 files changed

+45
-21
lines changed

README.md

Lines changed: 45 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
<img src="Shield/app/src/main/res/drawable/ic_launcher_round.png" alt="Logo" width="180" height="180">
1010
</a>
1111

12-
<h3 align="center">Shield - Social Distance Reminder</h3>
12+
<h3 align="center">🛡️Shield - Social Distance Reminder</h3>
1313

1414
<p align="center">
1515
Shield is a Social Distancing Reminder app. The app will identify when another person (someone with a phone and the app) comes too close to you using BLE RSSI (Received Signal Strength Indicator). This will be useful in places such as universities and offices where everyone has a smartphone and will have the application installed.
1616
<br />
17-
<a href="https://github.com/kavindaperera/nova-shield"><strong>Explore the docs »</strong></a>
17+
<a href="https://github.com/kavindaperera/nova-shield/tree/development/docs"><strong>Explore the docs »</strong></a>
1818
<br />
1919
<br />
2020
<a href="https://github.com/kavindaperera/nova-shield">View Demo</a>
@@ -28,7 +28,7 @@
2828

2929

3030
<!-- ABOUT THE PROJECT -->
31-
## About the Project
31+
## Welcome to 🛡️Shield!
3232

3333
[![Shield Banner][product-banner]](https://github.com/kavindaperera/nova-shield)
3434

@@ -47,53 +47,77 @@
4747

4848
### Onboarding
4949
<p align="">
50-
<img src="/docs/ui/onboarding_0.jpg" alt="onboarding" width="200"/>
51-
<img src="/docs/ui/onboarding_1.jpg" alt="onboarding" width="200"/>
52-
<img src="/docs/ui/signup_0.jpg" alt="signup" width="200"/>
50+
<img src="./docs/ui/onboarding_0.jpg" alt="onboarding" width="150"/>
51+
<img src="./docs/ui/onboarding_1.jpg" alt="onboarding" width="150"/>
52+
<img src="./docs/ui/signup_0.jpg" alt="signup" width="150"/>
53+
</p>
54+
<p alighn="justify">
55+
When a user first tries to install the Shield app, these 3 screens will appear in the shown order.
56+
The user can simply press the <strong>CONTINUE</strong> button on the first 2 screens and arrive at the Registration Screen.
57+
The user can enter a nickname to be used within the app and simply press the <strong>REGISTER</strong> button to complete the registration.
5358
</p>
5459

5560
<p align="right">(<a href="#top">back to top</a>)</p>
5661

5762
### Permissions
5863
<p align="">
59-
<img src="/docs/ui/permission_0.jpg" alt="permission" width="200"/>
60-
<img src="/docs/ui/permission_1.jpg" alt="permission" width="200"/>
61-
<img src="/docs/ui/permission_2.jpg" alt="permission" width="200"/>
62-
<img src="/docs/ui/permission_3.jpg" alt="permission" width="200"/>
64+
<img src="./docs/ui/permission_1.jpg" alt="permission" width="150"/>
65+
<img src="./docs/ui/permission_2.jpg" alt="permission" width="150"/>
66+
<img src="./docs/ui/permission_3.jpg" alt="permission" width="150"/>
67+
</p>
68+
69+
<p align="justify">
70+
71+
A user can start the Shield protection service by pressing the <img src="./docs/ui/start_btn.png" alt="start" width="30"/> button on the bottom right corner of the home screen. This will start a simple animation on the home screen which indicates that the Shield protection is ON. The user can leave the app after this and still the application will be running in the background.
72+
If the user needs to stop the Shield protection, then he/she needs to press the <img src="./docs/ui/stop_btn.png" alt="pause" width="30"/> button.
73+
6374
</p>
6475

6576
<p align="right">(<a href="#top">back to top</a>)</p>
6677

6778
### Home
6879
<p align="">
69-
<img src="/docs/ui/home_0.jpg" alt="home" width="200"/>
70-
<img src="/docs/ui/home_1.jpg" alt="home" width="200"/>
80+
<img src="./docs/ui/home_0.jpg" alt="home" width="150"/>
81+
<img src="./docs/ui/home_1.jpg" alt="home" width="150"/>
82+
</p>
83+
84+
<p align="justify">
85+
Shield app requires the users to grant location access permission. When the user first launches the app, a pop-up dialog box will appear as shown in the first figure. The user can then select the Yes option which will open the phone’s settings. Then user can grant the required permission as shown in the second figure. In order to run the app, it needs phone’s Bluetooth to be turned on. If Bluetooth is not on, then a pop-up dialog as shown in the third figure will appear.
7186
</p>
7287

7388
<p align="right">(<a href="#top">back to top</a>)</p>
7489

7590
### Notification Alerts
7691
<p align="">
77-
<img src="/docs/ui/notifications_0.jpg" alt="notifications" width="200"/>
78-
<img src="/docs/ui/notifications_1.jpg" alt="notifications" width="200"/>
92+
<img src="./docs/ui/notifications_0.jpg" alt="notifications" width="150"/>
93+
<img src="./docs/ui/notifications_1.jpg" alt="notifications" width="150"/>
7994
</p>
8095

8196
<p align="right">(<a href="#top">back to top</a>)</p>
8297

8398
### Friend List
8499
<p align="">
85-
<img src="/docs/ui/friends_1.jpg" alt="friends" width="200"/>
86-
<img src="/docs/ui/friends_2.jpg" alt="friends" width="200"/>
87-
<img src="/docs/ui/friends_3.jpg" alt="friends" width="200"/>
88-
<img src="/docs/ui/friends_5.jpg" alt="friends" width="200"/>
100+
<img src="./docs/ui/friends_1.jpg" alt="friends" width="150"/>
101+
<img src="./docs/ui/friends_2.jpg" alt="friends" width="150"/>
102+
<img src="./docs/ui/friends_3.jpg" alt="friends" width="150"/>
103+
<img src="./docs/ui/friends_5.jpg" alt="friends" width="150"/>
89104
</p>
90105

106+
<p align="justify">
107+
A user can access the Friends Screen by pressing the Friends Tab on the bottom navigation bar.
108+
By pressing the <img src="./docs/ui/add_btn.png" alt="add" width="30"/> button on the bottom right corner, a user can get the Scan QR Code & Display QR Code options. Using the Scan QR Code option, a user can scan the Shield QR Code of a close friend and add him/her to the whitelist. Using the Display QR Code option, a user can show his/her Shield QR Code to another person to scan.
109+
Once a user has added some friends to the whitelist, a <img src="./docs/ui/dlt_btn.png" alt="delete" width="30"/> button is shown at the bottom right corner if the user wants to remove someone from the whitelist.
110+
</p>
91111
<p align="right">(<a href="#top">back to top</a>)</p>
92112

93113
### Settings
94114
<p align="">
95-
<img src="/docs/ui/settings_0.jpg" alt="settings" width="200"/>
96-
<img src="/docs/ui/settings_1.jpg" alt="settings" width="200"/>
115+
<img src="./docs/ui/settings_0.jpg" alt="settings" width="150"/>
116+
<img src="./docs/ui/settings_1.jpg" alt="settings" width="150"/>
117+
</p>
118+
119+
<p align="justify">
120+
A user can access the menu which on the top right corner of home screen and go to the Settings Tab on that menu. It shows few options as shown in the figure here. By pressing the Mark as COVID-19 Infected option, a user can update the Firebase database so that other Shield users will get Exposed Notifications if they have been in contact with you within the last 7 days.
97121
</p>
98122

99123
<p align="right">(<a href="#top">back to top</a>)</p>
@@ -112,5 +136,5 @@ Radio Signal Strength Indication (RSSI) obtained by Bluetooth Low Energy Signals
112136

113137

114138
<!-- MARKDOWN LINKS & IMAGES -->
115-
[product-banner]: /docs/res/repository-open-graph-template.png
139+
[product-banner]: /docs/res/readme_banner.png
116140
[how-banner]: docs/res/avatars/4x/UG1%404x.png

docs/res/avatars/4x/UG1@4x.png

-1.17 KB
Loading

docs/res/readme_banner.png

950 KB
Loading

docs/ui/add_btn.png

10.3 KB
Loading

docs/ui/dlt_btn.png

12.3 KB
Loading

docs/ui/menu.png

2.82 KB
Loading

docs/ui/start_btn.png

10.6 KB
Loading

docs/ui/stop_btn.png

9.67 KB
Loading

0 commit comments

Comments
 (0)