Merge pull request #32 from eddex/update-readme

Update readme

README.md

@@ -1,18 +1,5 @@
 # HSLU simple MEP results
-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.
+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.
 
 Brought to you by [@Lextum](https://github.com/Lextum) and [@eddex](https://github.com/eddex)
 
@@ -22,11 +9,11 @@ Want to add some missing modules, fix a bug or add a new, awesome feature? That'
 
 ![screenshot](screenshot.png)
 
-The browser add-on puts the following features to the page 'Meine Anmeldungen' on 'MyCampus':
+The browser add-on extends the page with the following features:
 - A simple table with all your modules, credits and grades
 - An overview of how many modules of each type have been done / are still needed.
 - An overview of your grades including grade distribution and average.
-- A burndown chart to visualize your credit progress.
+- A chart to visualize your credit progress.
 
 ## Installation
 
@@ -68,7 +55,7 @@ Chrome does not support third party extensions anymore. Maybe we'll publish the
 
 ## Create a new release
 
-1. Update the version number in `src/manifest.json`
+1. Update the version number in `src/manifest.json`.
 2. Add everthing from `src` to a `.zip` file:
   - `data/` directory
   - `icons/` directory
@@ -78,10 +65,11 @@ Chrome does not support third party extensions anymore. Maybe we'll publish the
   - `main.js` file
   - `manifest.json` file
 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
-  - 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
+  - HSLU simple MEP results > Edit product page > Upload new version.
+  - Download the generated `.xpi` file.
+  - Change the end of the filename form `-fx.xpi` to `-firefox.xpi`.
+4. 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.
+5. Push your changes!
+6. Create a new release in this repo and attach the `.xpi` file.