chore: proofreading

Author: mbreithecker

Readme.md

@@ -23,23 +23,22 @@ source code a little and publish it on GitHub.
 ### Installation
 ```
 cd src
-zip ../Stud2NC src/*
+zip ../Stud2NC.zip ./*
 cd ..
 python3 Stud2NC.zip [args]
 ```
 Copy `Stud2NC.zip` and (the configured) `config.yaml` to a VPS and configure a
-crontab (`crontab -e`:
+crontab (`crontab -e`):
 ```
 */15 * * * * python3 Stud2NC.zip
 ```
 
 ### Local sync to file-system
 The easiest way to fetch files, is to just download them to 
 a local directory. However, this method does not check if
-the file has already been downloaded before.
-
-If you just want to fetch a module with all files and 
-announcements to your disk use:
+the file has already been downloaded before. Therefore,
+this is useful if you just want to fetch a module with all 
+files & announcements and save it to your disk.
 
 Enter the url and login credentials to the config.yaml
 to avoid passing everything as command-line args.
@@ -54,8 +53,8 @@ or environment-variables. For example passwords can be
 injected via the environment whereas the folder configuration 
 should be set in a config file.
 
-The `config.yaml` in this project can be used as a template
-it is heavily commented. Replace all the credentials and 
+The `config.yaml` in this project can be used as a template.
+It is heavily commented. Replace all the credentials and 
 specify the required modules.
 
 ### Contribution

src/models.py

@@ -40,7 +40,7 @@ def format_markdown(self) -> str:
 
     def get_hash(self):
         """
-        Returns hash of the announcement, needed to check for duplicated
+        Returns hash of the announcement, needed to check for duplicates
         :return: hash
         """
         text_to_hash = "-#-".join([self.title, self.date, self.content])