diff --git a/README.md b/README.md index ae06d10a..fddc2748 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,69 @@ - - + +

- A beautiful 🤩 Chrome Extension that adds additional features and gives an overall better experience for SEQTA Learn. Currently looking for contributors 🔥 + A beautiful 🤩 Chrome Extension that adds additional features and gives an overall better experience for SEQTA Learn. Currently looking for contributors 🔥

- ChromeDownload - + ChromeDownload +

+
+ + +
+ ## Table of contents - [Features](#features) - [Getting Started](#getting-started) - -## Release Videos - - -
- - -
+ - [Running Development](#running-development) + - [Building for production ](#building-for-production ) + - [Folder Structure](#folder-structure) +- [Contributors](#contributors) +- [Credits](#credits) +- [Star History](#star-history) ## Features - Dark mode - - Custom Background/Themes -- Improved Styling/CSS - - Improved look for SEQTA Learn -- Custom Home Page including: + - Custom Background/Themes +- Improved Styling/CSS + - Improved look for SEQTA Learn +- Custom Home Page including: - Daily Lessons - Shortcuts - - Easier Access Notices + - Easier Access Notices - Assessments -- Options to remove certain items from the side menu -- Fully customisable themes and an offical theme store -- Notification for next lesson (sent 5 minutes before end of the lesson) +- Options to remove certain items from the side menu +- Fully customisable themes and an offical theme store +- Notification for next lesson (sent 5 minutes before end of the lesson) - Browser Support - Chrome Supported - Edge Supported - Brave Supported - Opera Supported - Vivaldi Supported - - Firefox (Experimental - available [here](https://addons.mozilla.org/en-US/firefox/addon/betterseqta-plus/)) - - Safari (Experimental - only available via compilation) + - Firefox (Experimental - available [here](https://addons.mozilla.org/en-US/firefox/addon/betterseqta-plus/ )) + - Safari (Experimental - only available via compilation) ## Getting started -1. Clone the repository +1. Clone the repository ``` -git clone https://github.com/BetterSEQTA/BetterSEQTA-Plus +git clone https://github.com/BetterSEQTA/BetterSEQTA-Plus ``` ### Running Development -1. Install dependencies +1. Install dependencies ``` -npm install # or your preferred package manager like pnpm or yarn +npm install # or your preferred package manager like pnpm or yarn ``` 2. Run the dev script (it updates as you save files)