From 1f5398b6bae46b2c7f2689fd24b9f4f81fc048df Mon Sep 17 00:00:00 2001 From: Aman Bhaskar Date: Tue, 18 Oct 2022 23:13:06 +0530 Subject: [PATCH] readme update --- .gitignore | 1 + README.md | 71 ++++++++++++++++++++++++++++++++++++------------------ 2 files changed, 48 insertions(+), 24 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..59a114e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +AI \ No newline at end of file diff --git a/README.md b/README.md index 6d4f6a1..812c089 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,61 @@ -# UPSC-Star +# **UPSC-STAR** +![GitHub Repo stars](https://img.shields.io/github/stars/amanbh2/UPSC-Star?style=for-the-badge&color=brightgreen&logo=github) +![GitHub top language](https://img.shields.io/github/languages/top/amanbh2/UPSC-Star?style=for-the-badge&color=gold&logo=cplusplus) +![GitHub language count](https://img.shields.io/github/languages/count/amanbh2/UPSC-Star?style=for-the-badge&color=239ed8&logo=windowsterminal) +![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/amanbh2/UPSC-Star?color=f34b7e&style=for-the-badge) A website where UPSC aspirants can easily search and filter all previous year questions. -Link:https://amanbh2.github.io/UPSC-Star/ +``` +https://amanbh2.github.io/UPSC-Star/ +``` -#How to search questions: -+ Ensure right filter setting is set. -+ Type keyword in search area like - "water", "chola", "indus" etc. -+ It should be noted that the algorithm used in this website searches for all words that contains the keyword. For example if we search for "indus", the result will include all questions containing the word "indus", "industry" and others. -+ If you are seeking questions containing specifically "indus" only then add space at the end of your keyword as "indus ". Notice the space at the end. +## Instructions -#How to set filters: -+ At the right end of search bar we have filter button. Clicking it pops down all available filters. -+ Under year filters, select year to display question asked particulary in that year only. If no year is selected all questions from year 2013 to present will be displayed. -+ Under paper filters, one can choose to display questions from selected paper. By default GSI {General Studies -I} is selected, click to select different papers. +### How to search questions: -#Shortcut for desktop/laptop users: -+ Enter: To search -+ Esc: To reset +- Ensure right filter setting is set. +- Type keyword in search area like - "water", "chola", "indus" etc. +- It should be noted that the algorithm used in this website searches for all words that contains the keyword. For example if we search for "indus", the result will include all questions containing the word "indus", "industry" and others. +- If you are seeking questions containing specifically "indus" only then add space at the end of your keyword as "indus ". Notice the space at the end. -#Abbreviations: -+ GS-I: General Studies - I {History, Society & Geography} -+ GS-II: General Studies - II {Constitution, Polity & Governance} -+ GS-III: General Studies - III {Economy, Environment, Science & Technology, Internal Security & Disaster Management} -+ GS-IV: General Studies - IV {Ethics and Aptitude} +### How to set filters: -#Year: From 2013 to Present +- At the right end of search bar we have filter button. Clicking it pops down all available filters. +- Under year filters, select year to display question asked particulary in that year only. If no year is selected all questions from year 2013 to present will be displayed. +- Under paper filters, one can choose to display questions from selected paper. By default GSI {General Studies -I} is selected, click to select different papers. -#Dark Mode: The algorithm automatically sets dark theme from 20:00 IST to 05:00 IST. However the theme can be toggled easily by clicking on top right button. +### Shortcut for desktop/laptop users: + +- Enter: To search +- Esc: To reset + +## Abbreviations: + +- GS-I: General Studies - I {History, Society & Geography} +- GS-II: General Studies - II {Constitution, Polity & Governance} +- GS-III: General Studies - III {Economy, Environment, Science & Technology, Internal Security & Disaster Management} +- GS-IV: General Studies - IV {Ethics and Aptitude} + +## Year + +From 2013 to Present + +## Dark Mode + +The algorithm automatically sets dark theme from 20:00 IST to 05:00 IST. However the theme can be toggled easily by clicking on top right button. + +## Screenshots -#Screenshots -+ Desktop or Laptop: ![image](https://user-images.githubusercontent.com/69214242/179416307-aba6c497-d1bc-4cfc-95a5-0d533b3483a3.png) ![image](https://user-images.githubusercontent.com/69214242/179416323-97cba958-722f-497d-b384-a644be3460f9.png) +## Developer + +**Aman Bhaskar** -#Developer: Aman Bhaskar {https://github.com/amanbh2} +

+ + + +