Merge pull request #28 from eddex/update-readme

Update README.md

README.md

@@ -1,5 +1,18 @@
 # HSLU simple MEP results
-A browser extension to simplify viewing your MEP results. Shows all modules and the most important data about them in a simple list. It also provides an overview about your overall progress.
+This browser add-on extends the page ['Meine Andmeldungen'](https://mycampus.hslu.ch/de-ch/stud-i/mein-studium/meine-anmeldungen/) on the HSLU MyCampus website with the following features:
+- A simple table to view all your modules. The table shows:
+  - Module name
+  - Module type ('Kernmodul, Erweiterungsmodul, ...)
+  - Credits/ECTS
+  - Grade (F-A & 1-6)
+- The amount of credits you have achieved ordered by type of modules
+  - e.g. 'Kernmodule' 33/66
+- Your average grade
+- A distribution of your grades. Compare the amount of F-A grades.
+
+Under development:
+- A burndown chart that shows your remaining credits and an ideal reference line.
+- A bar chart showing the amount of credits you achieved each semester.
 
 Brought to you by [@Lextum](https://github.com/Lextum) and [@eddex](https://github.com/eddex)
 
@@ -9,6 +22,8 @@ Want to add some missing modules, fix a bug or add a new, awesome feature? That'
 
 ## Installation
 
+You only have to install the extension once. After this you'll get automatic updates!
+
 ### Firefox
 
 **Releases** (recommended)
@@ -45,14 +60,19 @@ Chrome does not support third party extensions anymore. Maybe we'll publish the
 
 ## Create a new release
 
-1. add everthing from `src` to a `.zip` file:
+1. Update the version number in `src/manifest.json`
+2. Add everthing from `src` to a `.zip` file:
   - `data/` directory
   - `icons/` directory
   - `components/` directory
   - `LICENSE` file
   - `main.js` file
   - `manifest.json` file
-2. login to https://addons.mozilla.org/en-US/developers/
+3. Login to https://addons.mozilla.org/en-US/developers/
   - HSLU simple MEP results > Edit product page > Upload new version
   - Download the generated `.xpi` file
-3. Create a new release in this repo and upload the `.xpi` file
+  - Change the end of the filename form `-fx.xpi` to `-firefox.xpi`
+4. Create a new release in this repo and upload the `.xpi` file
+5. Update `updates.json` with the new release.
+  - To get the `update_hash` generate the sha256 hash of the file
+  - e.g. `Get-Filehash hslu_simple_mep_results-2.0.8-firefox.xpi` in PowerShell