-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
6,720 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/node_modules | ||
web-ext-artifacts | ||
/dist | ||
/dist-dev |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.PHONY: clean | ||
clean: | ||
rm -rf dist web-ext-artifacts | ||
|
||
.PHONY: dev-prepare | ||
dev-prepare: | ||
npm install | ||
|
||
.PHONY: dev-build | ||
dev-build: | ||
npm run dev | ||
|
||
.PHONY: dev-run | ||
dev-run: | ||
npx web-ext run --source-dir dist | ||
|
||
.PHONY: build | ||
build: | ||
npm run build | ||
npx web-ext build --source-dir dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# hn-tldr-extension | ||
# Hacker News TL;DR | ||
|
||
A browser extension for summarizing Hacker News articles with LLMs. | ||
A bring-your-own-key browser extension for summarizing Hacker News articles with LLMs. | ||
|
||
The extension will add the summarize buttons to the HN front page and article pages. Just provide your Anthropic (or soon OpenAI) API key and you're good to go. | ||
|
||
![Screenshot 1](screen1.png) | ||
|
||
![Screenshot 2](screen2.png) | ||
|
||
## Development | ||
|
||
To start development: | ||
``` | ||
make dev-prepare | ||
``` | ||
|
||
Dev build: | ||
``` | ||
make dev-build | ||
``` | ||
|
||
Load into Firefox: | ||
``` | ||
make dev-run | ||
``` | ||
|
||
Production build: | ||
``` | ||
make build | ||
``` | ||
|
||
## License | ||
|
||
This project is licensed under the GPL-3.0 license. See the [LICENSE](LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
{ | ||
"manifest_version": 3, | ||
"name": "Hacker News TL;DR", | ||
"version": "0.1.0", | ||
"description": "A bring-your-own-key extension for summarizing Hacker News articles with LLMs.", | ||
"icons": { | ||
"48": "icon.svg", | ||
"96": "icon.svg" | ||
}, | ||
"browser_specific_settings": { | ||
"gecko": { | ||
"id": "[email protected]" | ||
} | ||
}, | ||
"permissions": [ | ||
"storage" | ||
], | ||
"host_permissions": [ | ||
"<all_urls>" | ||
], | ||
"action": { | ||
"default_title": "Show options" | ||
}, | ||
"options_ui": { | ||
"page": "options.html" | ||
}, | ||
"content_scripts": [ | ||
{ | ||
"matches": ["*://news.ycombinator.com/*"], | ||
"js": [ | ||
"browser-polyfill.js", | ||
"content.js" | ||
] | ||
} | ||
], | ||
"background": { | ||
"scripts": [ | ||
"browser-polyfill.js", | ||
"background.js" | ||
] | ||
} | ||
} |
Oops, something went wrong.