Skip to content

Commit

Permalink
Improved Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Abhijeetbyte authored Jun 12, 2023
1 parent 70982df commit 75af028
Showing 1 changed file with 61 additions and 2 deletions.
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,61 @@
# ClipSwipe
Automatically navigate YouTube videos using keyboard shortcuts in order to Skip Adds.
<p align="center">
<h1 align="center">ClipSwipe</h1>
<h4 align="center">
"Automatically navigate YouTube videos using keyboard shortcuts in order to Skip Adds"
</h4>
<br>
</p>


<!-- Badge section -->

[![Releases](https://img.shields.io/badge/Github-Releases-blue)](https://github.com/Abhijeetbyte/ClipSwipe/releases)
[![license](https://img.shields.io/github/license/abhijeetbyte/MYPmanager)](LICENSE)
[![Languages](https://img.shields.io/badge/Javascript-FFD43B?&logo=javascript&logoColor=blue)](#)
[![Platform](https://img.shields.io/badge/Chrome-0078D6?&logo=chrome&logoColor=white)](README.md) <!--added redme links, just to not go elseweher -->

</br>

## Features
* No Content Analysis, Element Detection/Blocking or Blocking network requests etc.
* Only work locally within the user's browser to prevent ads from being played on `Youtube`.
<br/>


The purpose of this "ClipSwipe" ad blocker is to improve the user's watching experience by removing intrusive or unwanted advertisements. It does not involve redirecting ads to different servers or altering the ad delivery process.


## Getting started

<b>Prerequisites</b>:

* Your computer must be running on Chrome Version 114.0.5735.110 or newer

* Get the Latest Version of the [Extension](https://github.com/Abhijeetbyte/ClipSwipe/archive/refs/heads/main.zip)

* Extract the zip and delete unnecessary files, except `background.js` , `content.js`, `manifest.json` and `popup.html` </br>

* Open Google Chrome, in the address bar, enter "chrome://extensions" to open the Extensions page.

* Toggle the "Developer mode" switch located at the top-right corner of the Extensions page.
- ![Dev-mode](img/dev.png)

* Click on the "Load unpacked" button that appears after enabling Developer mode.

* In the file explorer window that appears, navigate to the location where you saved the "ClipSwipe" folder, select it, and click "Open".
<br>

Chrome will automatically load and install your extension from the zip file. You should see the "ClipSwipe" extension appear in the list of installed extensions on the Extensions page. <br/>



## Reporting Issues & Contributions

Feel free to report <b>[issues](https://github.com/Abhijeetbyte/ClipSwipe/issues/new)</b> and <b>contribute</b> to this repository


## License

Copyright © 2022 Abhijeet kumar. All rights reserved.

Licensed under the [CC0-1.0 License](LICENSE).

0 comments on commit 75af028

Please sign in to comment.