TL;WR

TL;WR automatically summarizes long Reddit posts and threads into concise, easy-to-read bullet points. It is designed for users who want to get the gist of a discussion without wading through walls of text.

Demo

Installation

1. For Users (The Easy Way)

The easiest way to use TL;WR is to install it from the official store:

• Firefox Add-ons

2. For Developers (Run Locally)

1. Clone the repository :

git clone https://github.com/ayoubchwt/TL-WR.git

2. Load into Firefox:

1. Open Firefox and enter about:debugging in the address bar.
2. Select This Firefox from the left sidebar.
3. Click the Load Temporary Add-on button.
4. Navigate to the tl-wr folder and select the manifest.json file.

Usage

Features

• Instant Summaries: Automatically condenses long Reddit posts and threads into concise, easy-to-read bullet points.
• Save Time: Get the gist of a 5,000-word story in seconds without scrolling through walls of text.
• Privacy-First: No tracking or data collection.

Tech Stack

• JavaScript (ES6+) - Core logic and DOM manipulation.
• HTML5 & CSS3 - Structure and styling for the reading mode interface.
• WebExtensions API - Used to interact with the browser tab and context menu.

Contributing

Since TL;WR is built with Vanilla JS, it's very easy to jump in! You don't need to set up complex build environments, just edit the code and test.

1. Fork the Project (Click the "Fork" button at the top right of this page).
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Make your Changes.
4. Test Locally (Reload the extension in about:debugging to see your changes).
5. Commit your Changes (git commit -m 'Add some AmazingFeature').
6. Push to the Branch (git push origin feature/AmazingFeature).
7. Open a Pull Request.

Found a Bug?

If you find a bug or have a feature request, please open an issue first to discuss what you would like to change.

License

Distributed under the MIT License. See LICENSE for more information.