From 0b0d4e21970aab3245df46d91eb155a1e270a397 Mon Sep 17 00:00:00 2001 From: Numan Zaman Dipu Date: Mon, 24 Apr 2023 14:08:05 +0600 Subject: [PATCH] update README.md v1.2 --- README.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc0d203..8e0bdcd 100644 --- a/README.md +++ b/README.md @@ -1 +1,92 @@ -# Notation \ No newline at end of file +

+ Notation +

+ +
+ Report a Bug + ยท + Request a Feature + . + Ask a Question +
+ + +
+
+ + [![license](https://img.shields.io/badge/License-%20Apache--2.0-%230018cf)](LICENSE) + [![Pull Request](https://img.shields.io/badge/Pull%20Requests-Welcome-%2300910c)](https://github.com/numanzamandipuu/Notation/pulls) + [![Issues](https://img.shields.io/badge/Issues-Welcome-%23570091)](https://github.com/numanzamandipuu/Notation/issues) + [![Made With Love](https://img.shields.io/badge/Made%20With-Love-%23ff003c)](https://github.com/numanzamandipuu/) + +
+ +![Repository Banner](https://user-images.githubusercontent.com/72611571/233857358-53d9dc13-0b11-4685-99a4-9a41afd2b9ea.png) + +
+ +### Notation is a Chromium-Based Browser extension that uses a special algorithm to highlight the first syllable of a word, allowing readers to focus on the highlighted parts and read up to 1.75x faster. With customizable font weight and opacity, Notation enhances the reading experience on any website. + +
+
+ + +
+ + +

Table of Contents

+ + + - [Installation](#installation) + - [Features](#features) + - [System Architecture](#system-architecture) + - [Usage](#usage) + - [Contributing](#contributing) + - [Installation](#installation) + - [HTTPS](#https) + - [SSH](#ssh) + - [GitHub CLI](#github-cli) + - [GitHub Desktop](#github-desktop) + - [Support](#support) + - [License](#license) + - [Acknowledgements](#acknowledgements) + +
+ + +# Installation + + + +# Features + +To make this Extension more user-friendly and accessible, the following features have been included: + + - [**Easy Installation:**](#installation) Installation is a breeze with Notation. Our [well-documented guide](#installation) ensures you'll be up and running in no time. + + - [**Stunning UI:**](https://github.com/numanzamandipuu/Notation/tree/main/src/popup) Notation features a visually impressive User Interface that is easy to navigate and a pleasure to use. + + - [**Comprehensive Documentation:**](https://github.com/numanzamandipuu/Notation#readme) Our Extension has a detailed README file, providing all the necessary information and instructions. Our documentation is an informative guide to help you get the most out of Notation. + + - [**Stellar Support:**](https://github.com/numanzamandipuu/Notation/issues) We are committed to providing exceptional support to our users. If you encounter any problems, drop an [Issue here](https://github.com/numanzamandipuu/Notation/issues), and we will work quickly to resolve them to ensure your experience with Notation is as smooth as possible. + + - [**Contributions Welcome:**](https://github.com/numanzamandipuu/Notation/pulls) The repository is open to contributions from the community. Users can contribute their own solutions or even suggest improvements to existing ones. + + - [**License:**](LICENSE) This repository follows the Apache-2.0 license. Users can use and modify the code for personal and commercial purposes if they give appropriate credit and maintain the license terms. + +Overall, the purpose of this Extension is to enhance the reading experience of users and, in the meantime, to provide a centralized location for users and developers to access and contribute to the codebase. + + + +# System Architecture + + +# Usage + +To use the repository, navigate to the relevant folder for the problem you're interested in. Then follow the following steps: + +- Each folder contains a C++ solution file and a README file with the original problem link. You can have a look to those files. +- Review the solution code and problem statement to gain insight into how the problem was solved. +- Contribute to the repository by submitting solutions to existing problems or adding new solutions following the Contribution Guidelines. + +This repository is intended to provide a resource for competitive programmers of all levels, from beginners to advanced, looking to improve their problem-solving skills and explore new algorithms and data structures.