Skip to content

Commit

Permalink
Improve README and add links
Browse files Browse the repository at this point in the history
  • Loading branch information
niklashenning committed Aug 11, 2024
1 parent 1f58c08 commit 8b92764
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,20 @@

<div align="center">

[![Version](https://img.shields.io/badge/version-v1.0.0-blue)](https://github.com/niklashenning/leetcode-block-users)
[![Version](https://img.shields.io/badge/version-v1.0.0-blue)](https://chromewebstore.google.com/detail/leetblock-block-leetcode/dopkcagmapfpgabhpnbdonlejcidmpel)
[![Build](https://img.shields.io/badge/build-passing-neon)](https://github.com/niklashenning/leetcode-block-users)
[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/niklashenning/leetcode-block-users/blob/master/LICENSE)

</div>

<p align="center">Easily block users on Leetcode so they will never show up in comments or replies again</p>
<p align="center">
Easily block users on Leetcode so they will never show up in comments or replies again.
<br>
Get rid of bots, spammers, self-advertisers, and people posting solutions in the discussion section.
<br>
<br>
<a href="https://chromewebstore.google.com/detail/leetblock-block-leetcode/dopkcagmapfpgabhpnbdonlejcidmpel"><strong>Install Leetblock »</strong></a>
</p>

<p align="center">
<img src="https://github.com/user-attachments/assets/03e9fcc6-1e48-44b0-97ec-cd92266a1401" width="650px"/>
Expand All @@ -21,14 +28,14 @@
## Installation

### Chrome Web Store
You can install the extension through the [Chrome Web Store](https://github.com/niklashenning/leetcode-block-users) on browsers such as Google Chrome, Microsoft Edge, Opera, and Brave.
Simply follow [this link](https://github.com/niklashenning/leetcode-block-users) and click on the "Add to Chrome" or "Get" button, depending on your browser.
You can install the extension through the Chrome Web Store on browsers such as Google Chrome, Microsoft Edge, Opera, and Brave.
Simply follow [this link](https://chromewebstore.google.com/detail/leetblock-block-leetcode/dopkcagmapfpgabhpnbdonlejcidmpel) and click on the "Add to Chrome" or "Get" button, depending on your browser.

### Installing locally
Alternatively, you can install the extension locally by following these steps:
1. Clone the repository

```sh
```
git clone https://github.com/niklashenning/leetblock.git
```
Expand All @@ -43,7 +50,7 @@ Alternatively, you can install the extension locally by following these steps:
## Usage
### <ins>Blocking users in discussions</u>
After enabling the extension, red "Block" buttons will appear on every comment and reply. Clicking it will add that user to the block list and hide all of their posts as long as you keep them blocked.
After enabling the extension, "Block" buttons will appear on every comment and reply. Clicking it will add that user to the block list and hide all of their posts as long as you keep them blocked.
### <ins>Blocking users manually</u>
If you want to manually block a user by username, click on the extension icon to open the popup, enter the username into the text field, and click the "Block User" button.
Expand All @@ -52,7 +59,7 @@ If you want to manually block a user by username, click on the extension icon to
To unblock a user, simply open the extension popup, locate the username in the list, and click the "Unblock" button next to it.
### <ins>Unblocking all blocked users</u>
To unblock every user, open the extension popup and click the "Unblock All" button. After confirming your decision, your block list will be cleared and all posts will be visible again.
To unblock every user, open the extension popup and click the "Unblock All" button. After confirming your decision, your block list will be cleared, and all posts will be visible again.
## Demo
Expand Down

0 comments on commit 8b92764

Please sign in to comment.