https://github.com/nulldev/tldr-extension

TL;DR Extension - Ask websites anything
https://github.com/nulldev/tldr-extension

Last synced: 10 months ago
JSON representation

TL;DR Extension - Ask websites anything

• Host: GitHub
• URL: https://github.com/nulldev/tldr-extension
• Owner: NullDev
• License: mit
• Created: 2024-07-31T11:31:19.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-01-22T16:10:11.000Z (about 1 year ago)
• Last Synced: 2025-03-19T21:27:41.080Z (10 months ago)
• Language: JavaScript
• Size: 269 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# tl;dr

[![License](https://img.shields.io/github/license/NullDev/tldr-extension?label=License&logo=Creative%20Commons)](https://github.com/NullDev/tldr-extension/blob/master/LICENSE) [![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/NullDev/tldr-extension?logo=Cachet)](https://github.com/NullDev/tldr-extension/issues?q=is%3Aissue+is%3Aclosed) [![ESLint](https://github.com/NullDev/tldr-extension/actions/workflows/eslint.yml/badge.svg)](https://github.com/NullDev/tldr-extension/actions/workflows/eslint.yml) ![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/NullDev/tldr-extension/master?label=version)



tl;dr - Ask websites anything



## :question: What does it do?

This is a Chrome Extension that allows users to asks websites specific questions about their content. The page content is sanitized and sent to Gemini along with the question of the user. 



It is my submission for the Google AI Competition: 

- https://ai.google.dev/competition/projects/tldr

- https://web.archive.org/web/20240904205925/https://ai.google.dev/competition/projects/tldr (Archive)

**Demo Video:** https://www.youtube.com/watch?v=1dtRHrxl8lc



## :star: Downloading the extension

The extension can be downloaded from the official Chrome store: 


https://chromewebstore.google.com/detail/tldr/ceoomcdkamoifgcdeflofkdmpjmmcnka



## :diamond_shape_with_a_dot_inside: Feature requests & Issues

Feature request or discovered a bug? Please [open an Issue](https://github.com/NullDev/tldr-extension/issues/new/choose) here on GitHub.



## :wrench: Building yourself [DEV ONLY]

0. Open up your favourite terminal (and navigate somewhere you want to download the repository to). 



1. Make sure you have NodeJS installed. Test by entering 


$ `node -v` 


If this returns a version number, NodeJS is installed. **If not**, get NodeJS here. 



2. Clone the repository and navigate to it. If you have Git installed, type 


$ `git clone https://github.com/NullDev/tldr-extension.git && cd tldr-extension` 


If not, download it here and extract the ZIP file.


Then navigate to the folder.



3. Install all dependencies by typing 


$ `npm install`



3. Build it by typing 


$ `npm run build`



3.1 Or debug it by typing 


$ `npm run dev`



4. Once built, in Chrome, go to `chrome://extensions/`, click "load unpacked" and select the dist folder in the repo. 



5. Click on the extension, click the gear icon, and paste your gemini key. Then hit save 



6. Done!



## :satellite: Using prepacked extension [DEV ONLY]

1. Download the [latest crx from the release page](https://github.com/NullDev/tldr-extension/releases) 



2. Either go to `chrome://extensions/` and drag-n-drop the crx in there, or open the crx with chrome. Then enable it (!) which might require enabling dev mode

3. Once the extension is loaded: Click on it, then click the gear icon and paste your gemini key. Then hit save 



4. All done! You can now use tl;dr :) 

If that does not work, see [Building yourself](#wrench-building-yourself).



## :lock: Data Protection Disclaimer

This extension does not store any personal data. However website content that might include personal data is sent to Google Gemini AI when a question is submitted.