Skip to content

Commit d77869b

Browse files
committed
updated README
1 parent d09f1bf commit d77869b

File tree

4 files changed

+87
-2
lines changed

4 files changed

+87
-2
lines changed

README.md

+87-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,87 @@
1-
# codeforces-customizer
2-
A chrome extension for customising the codeforces website
1+
![GitHub top language](https://img.shields.io/github/languages/top/cs-mshah/codeforces-customizer)
2+
![GitHub issues](https://img.shields.io/github/issues/cs-mshah/codeforces-customizer)
3+
4+
<!-- PROJECT LOGO -->
5+
<br />
6+
7+
<p align="center">
8+
<a href="https://github.com/cs-mshah/codeforces-customizer/">
9+
<img src="./src/icons/header_logo.png" alt="Logo">
10+
</a>
11+
<h3 align="center">Codeforces Customizer</h3>
12+
13+
<p align="center">
14+
A chrome extension to customize codeforces.
15+
<br />
16+
<a href="https://github.com/cs-mshah/codeforces-customizer/"><strong>Explore the docs »</strong></a>
17+
<br />
18+
<a href="https://github.com/cs-mshah/codeforces-customizer/issues">Report Bug</a>
19+
·
20+
<a href="https://github.com/cs-mshah/codeforces-customizer/issues">Request Feature</a>
21+
·
22+
<a href="https://github.com/cs-mshah/codeforces-customizer/pulls">Send a Pull Request</a>
23+
</p>
24+
</p>
25+
26+
<!-- ABOUT THE PROJECT -->
27+
28+
## About The Project
29+
30+
Wouldn't it be nice if we had this feature on codeforces? Everyone thinks about this question, and with the same thought, I thought of creating a browser extension that would customize certain features and make the user experience better.
31+
Here are the current features:
32+
33+
### _Enhanced Blog View:_
34+
Codefoces provides a way to star your favourite blogs and view them under the favourites tab in your profile. But after the starring many blogs, there is a long scrollbar and it becomes very hard to get what you are looking for. Well, no need to worry anymore!
35+
36+
<img src="./screenshots/blogEntries.png">
37+
38+
- No need to scroll through all blogs!
39+
- All blogs appear hidden, reducing scrolling.
40+
- Custom searchbar to search blog titles you are looking for.
41+
- Expand/Hide individual blogs to see content.
42+
- Works on favourite blogs and particular user blogs tab.
43+
44+
<br>
45+
46+
### _All submissions tab:_
47+
48+
<img src="./screenshots/problemset.png">
49+
50+
- Directly go to all submissions (status tab) from the problem page for the current problem.
51+
52+
<br>
53+
54+
### _Show results with user lists by default:_
55+
56+
<img src="./screenshots/userLists.png" height="30%" width="30%">
57+
58+
- No need to select the user list in problemset/contest page everytime.
59+
- Go to https://codeforces.com/lists and enter the list key in the input box of the extension popup and press __enter__.
60+
- Now the problemset/contest page will show the results using the list by default.
61+
62+
<!-- GETTING STARTED -->
63+
## Getting the extension
64+
65+
1. Simply go to the chrome web store : and click on _add to chrome_, or,
66+
2. Go to [Releases](https://github.com/cs-mshah/codeforces-customizer/releases), download and extract the package. Now go to chrome://extensions/ , select load unpacked and select the extracted package.
67+
68+
<!-- USAGE EXAMPLES -->
69+
## Usage
70+
71+
All features are independent and are made to enhance the user experience. Installing the extension enables all features by default. But if you feel that you are good without one, then you can simply disable the feature in the extension popup.
72+
73+
<!-- ROADMAP -->
74+
## 🚧 Roadmap
75+
76+
See the [open issues](https://github.com/cs-mshah/codeforces-customizer/issues) for a list of proposed features (and known issues).
77+
78+
<!-- CONTRIBUTING -->
79+
## 🤝 Contributing
80+
81+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **extremely appreciated**.
82+
83+
1. Fork the Project
84+
2. Create your Feature Branch (`git checkout -b newFeature`)
85+
3. Commit your Changes (`git commit -m 'Added a new feature'`)
86+
4. Push to the Branch (`git push origin newFeature`)
87+
5. Open a Pull Request

screenshots/blogEntries.png

70.7 KB
Loading

screenshots/problemset.png

55.2 KB
Loading

screenshots/userLists.png

49.2 KB
Loading

0 commit comments

Comments
 (0)