Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jiin-kim109 committed Aug 30, 2023
1 parent 9f2fc2b commit f004b91
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,34 @@
<h1>SFU RateMyProfessor</h1>
<img src="./images/sfu_rmp_logo.png" width="300" height="300">
</div>
<br />
<div align="center">
<a href="https://chrome.google.com/webstore/detail/sfu-ratemyprofessor-exten/jblfjeooajgbckndgbjbimmknggeibjn?hl=ko&authuser=0">
<img src="https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/iNEddTyWiMfLSwFD6qGq.png">
</a>
<a href=".">
<img src="https://github.com/jiin-kim109/SFU-RMP/actions/workflows/node.js.yml/badge.svg"/>
</a>
</div>
<br />
<br />

Chrome extension for SFU students to provide access to prof rating from RateMyProfessor.com on SFU course registration pages (goSFU, mySchedule).
SFU RMP is a Chrome extension designed for SFU students, providing convenient access to professor ratings from RateMyProfessor.com on SFU course registration pages (goSFU, mySchedule).

This displays the professor ratings on every professor name appeared on goSFU and mySchedule. Hover your mouse on the professor names and the related RMP rating info.
After installing the extension from the Chrome Store, you will notice that professor names are underlined and highlighted. Hover your mouse over the professor names, and tooltips containing ratings will be displayed as follows:

<div align="center">
<img src="./images/screenshot1.png" width="400" height="280">
<img src="./images/screenshot2.png" width="400" height="280">
</div>

<br />
<div align="center">
<a href="https://chrome.google.com/webstore/detail/sfu-ratemyprofessor-exten/jblfjeooajgbckndgbjbimmknggeibjn?hl=ko&authuser=0">
<img src="https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/iNEddTyWiMfLSwFD6qGq.png">
</a>
</div>

## Running in the Development Mode
1. Clone or download the repository.
2. Enter the extension setting page and enable **Developer Mode**
3. Click the top left **Load unpacked** button and select the repository directory.

## Running Tests

<div>
<a href=".">
<img src="https://github.com/jiin-kim109/SFU-RMP/actions/workflows/node.js.yml/badge.svg"/>
</a>
<div>

1. `npm install` to install dev dependencies
2. `npm test` to run all test cases
Expand Down

0 comments on commit f004b91

Please sign in to comment.