Skip to content

Commit

Permalink
Updated READEME.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MohamedAAbdallah committed Sep 7, 2024
1 parent d50bd0c commit 09fc8d4
Showing 1 changed file with 14 additions and 24 deletions.
38 changes: 14 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,34 @@
# **SIS Darkmode**
# **ModernSIS**

![SIS Darkmode Logo](src/icons/128.png)
![ModernSIS Logo](src/icons/128.png)

**Version**: 0.1.1.0
**License**: [GNU General Public License v3.0](LICENSE)

A Web extension that applies a modern dark mode theme to the AOU Student Information System (SIS) pages for a more comfortable, eye-friendly browsing experience during extended usage.

## **Table of Contents**

1. [Introduction](#introduction)
2. [Features](#features)
3. [Usage](#usage)
4. [Contributing](#contributing)
5. [Code of Conduct](#code-of-conduct)
6. [Acknowledgments](#acknowledgments)
7. [License](#license)
8. [Contact](#contact)
ModernSIS brings a fresh, visually appealing dark theme to the AOU Student Information System (SIS) pages. With a modern look, multiple color modes, and enhanced privacy features, ModernSIS is designed to enhance readability, reduce eye strain, and maintain the original functionality of the SIS platform.

---

## **Introduction**

SIS Darkmode is designed to provide a visually appealing dark theme for the AOU Student Information System (SIS) pages, specifically targeting the domains `sisksa.aou.edu.kw` and `sis.aou.edu.kw`. This extension enhances readability, reduces eye strain, and offers a modern look while preserving the original functionality of the SIS platform.
ModernSIS enhances the AOU Student Information System (SIS) pages with a modern, eye-friendly dark theme, targeting the domains `sisksa.aou.edu.kw` and `sis.aou.edu.kw`. The extension now includes multiple color modes and improved privacy settings, while continuing to offer a sleek, modern browsing experience.

## **Features**

- πŸŒ‘ **Dark Mode Theme**: A consistent, eye-friendly dark theme across SIS pages.
- πŸ–₯️ **Supports Multiple Pages**: Compatible with all AOU SIS pages.
- 🎨 **Multiple Color Modes**: Three color modes to choose from, with new colors coming soon.
- πŸ–₯️ **Supports Multiple Pages**: Compatible with all AOU SIS Regions.
- πŸš€ **Lightweight and Fast**: Minimal impact on browser performance.
- πŸ”§ **Easy Installation and Use**: Quick setup with one-click installation from Popular Web Stores.
- πŸ” **Privacy**: Only CSS code will be altered without reading or writing to your data.
- πŸ”§ **Easy Installation and Use**: Quick setup with one-click installation from popular web stores.
- πŸ” **Privacy Focused**: No personal data is ever read or written; only CSS code is altered.
- 🚫 **Enhanced Security**: Automatically disables itself on financial, Reports, or exam-related pages to protect your privacy.

## **Usage**

Once installed, SIS Darkmode will automatically activate the dark theme on any page under the specified SIS domains (`*.aou.edu.kw`).
Once installed, ModernSIS will automatically activate the dark theme or your selected color mode on any page under the specified SIS domains (`*.aou.edu.kw`), except financial or exam-related pages.

## **Contributing**
## **Contributing** [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)

We welcome contributions to enhance the SIS Darkmode extension. To contribute:
We welcome contributions to enhance the ModernSIS extension. To contribute:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
Expand Down Expand Up @@ -76,6 +66,6 @@ For any questions, suggestions, or issues, please feel free to reach out:
- **Email**: [eng.mohamed.a.abdallah@gmail.com](mailto:eng.mohamed.a.abdallah@gmail.com)
- **GitHub**: [MohamedAAbdallah](https://github.com/MohamedAAbdallah)

### **Enjoy a better browsing experience with SIS Darkmode! πŸŒ™**
### **Enjoy a modern and stylish browsing experience with ModernSIS! πŸŒ™**

---
---

0 comments on commit 09fc8d4

Please sign in to comment.