Updating Readme (#298)

* Updatin Readme Updating to readme to show how to updated the database. see #297 * typos * Updating Readme Specified where to find credentials and which database to use * Updating DB in readme. Updated Database in Readme --------- Co-authored-by: Joel <[email protected]>
digital-sustainability · Sep 19, 2023 · 33383b4 · 33383b4
1 parent 4a564a1
commit 33383b4
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -41,4 +41,15 @@ The crawler will just update the data, starting with the oldest timestamp.
 
 ## Database Stucture
 
-![System Diagram](/assets/images/DBStructure.png)
+![System Diagram](/assets/images/DBStructure.png)
+
+## Update Institutions
+
+Once someone has updated the github_repos.json file and the pull request was merged, the new or updated insitution must be added to the database.
+
+This can be done in 4 easy steps:
+
+1. Pull Repository
+2. Connect to DB with MongoDB Compass. The Credentials can be found in Keepass
+3. Choose the **production** DB and then todoInstitution collection.
+4. Press **Add Data -> Import file** and choose github_repos.json. Keep in mind that *Stop on errors* needs to be unchecked. Then just click *Import*.