Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CallMeGodsent committed Jan 17, 2025
1 parent fb30871 commit d94f000
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
---
>-
1. [Features](#features) 2. [Installation](#installation) 3. [Usage](#usage)
4. [Example](#example) 5. [Options](#options) 6. [How It Works](#how-it-works)
7. [Changelog](#changelog) 8. [To-Do List](#to-do-list) 9.
[Contributing](#contributing) 10. [License](#license) 11. [Author](#author)
---

# StopEdit - A Lightweight JavaScript Library to Protect Your Page 🛡️

StopEdit is a simple JavaScript library designed to keep your webpage safe from unwanted changes. It actively monitors your page for edits and resets everything back to its original state. Whether it's someone tampering with "Inspect Element" or trying to edit your content directly, StopEdit has you covered.
Expand All @@ -19,6 +11,22 @@ StopEdit is a simple JavaScript library designed to keep your webpage safe from

--------------------------------------------------------------------------------

## 🔰 Basic Explanation

a lot of people are asking me, "Godsent! What have you got up there again? We don't understand it". And most times, I just tell them, "Go read the description again."

So, what actually is this my lib about? The shortest anser is that, "It let you stop bad guys from editing anything in your live website by manipulating the frontend. Some bad guys can add extra CSS, HTML, JS, etc and even make themselves or their names verified in your site to trick unsuspecting people.

So, how did i fix a lot of problems by kicking thousands of potential attackers or bad guys away? I created STOPEDIT which by the end of this season would be able to do a lot of things. For now, the To-Do would keep you posted on what has been done. So, what is the motivation?

- stop bad guys from making changes to your hosted live site by using inspect element, etc
- stop bad guys from viewing the original url of images, from downloading images, etc
- prevent aliens from scrapping your site just because they feel its good
- block all kind of suspicious activities as long as they attempt any kind of "edit"
- disable content copy, add watermark text, prevent printing, etc

--------------------------------------------------------------------------------

## ⚙️ Installation

To install StopEdit, simply download the `StopEdit.js` file and include it in your HTML file:
Expand Down

0 comments on commit d94f000

Please sign in to comment.