Add Readme

ristokekovic · Aug 16, 2020 · 5cfb242 · 5cfb242
1 parent 6250680
commit 5cfb242
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/Assets/Resources/markers.png b/Assets/Resources/markers.png
diff --git a/Assets/Resources/videos.png b/Assets/Resources/videos.png
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# COVID-AR
+COVID-AR is a Unity and Vuforia app designed to help educate medical staff how to put on Personal Protective Equipment (PPE) at hospitals and other medical institutions.
+
+## Markers
+
+The following markers can be used with the app:
+
+![markers](Assets/Resources/markers.png)
+
+## Videos
+
+Scanning the markers with the app will show the video clips demonstrating how to properly execute these steps and be protected in the workplace.
+
+![videos](Assets/Resources/videos.png)
+
+Here is an example video clip demonstrating one of the steps:
+
+<video src="Assets/Resources/3. Postavljanje maske.mp4"></video>
+
+That's it! Put the app to a good use and stay safe out there!