Merge pull request #1 from da-stoi/typescript-refactor

Typescript refactor

.gitignore

@@ -1,4 +1,6 @@
+/dist/
+/node_modules/
 .vscode
 .DS_Store
-archives
-promotional
+/archives/
+/promotional/

README.md

@@ -4,15 +4,25 @@
 - [School\University Add Form](https://forms.gle/noC8sKiVoMDat9jP6)
 
 ### What is it?
-__Canvas Class Average__ is a *Chrome Extension* that calculates a class average for a Canvas course.
+__Canvas Class Average__ is a *Chrome Extension* that calculates a class average for a Canvas course. It also displays your grade and the average grade history, how it changed over time, and both your and the average grade by weight group.
 
 ### How does it work?
 After installing the extension, simply navigate to the grades page of a Canvas course. The extension will automatically calculate the class average and display it on the page under your score in the course.
 
+To change settings, go to the Canvas settings page by clicking your profile picture in the top left, and pressing __Settings__, then just scroll down to the __Class Average__ section.
+
+### Features
+- Calculates the class average for a Canvas course.
+- Shows your grade and the average grade history.
+- Displays how you are doing compared to the class average.
+- Displays your grade and the average grade by weight group.
+  - If used, weight groups are how your instructor makes an exam worth more towards your final grade than homework for example.
+- Is transparent about how and when the class average may be inaccurate.
+
 ### Things to note
-- The average may not be 100% accurate, especially if your teacher/professor doesn't use Canvas correctly. 
-- It **does not** account for class curving, or any other special grading rules besides assignment group weights.(Assignment weights only work if your teacher/professor has them set up through Canvas.)
-- The extension will not work if your teacher/professor has assignment averages hidden.
+- The average may not be 100% accurate, especially if your instructor doesn't use Canvas correctly. 
+- It **does not** account for class curving, or any other special grading rules besides assignment group weights.(Assignment weights only work if your instructor has them set up through Canvas.)
+- The extension will not work if your instructor has assignment averages hidden.
 
 ---
-[<img src="https://simpleblocker.com/images/chrome-webstore@2x.png" style="display: block; margin-left: auto; margin-right: auto;" width="250"/>](https://chrome.google.com/webstore/detail/canvas-class-average/kpoimdffnaajacmnejfnahjdjbdlfjgf)
+[<img src="https://da-stoi.github.io/portfolio-assets/assets/chromeWebStore/availableDark.png" style="display: block; margin-left: auto; margin-right: auto;" height="50"/>](https://chrome.google.com/webstore/detail/canvas-class-average/kpoimdffnaajacmnejfnahjdjbdlfjgf)