-
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
0 parents
commit d65b3d1
Showing
24 changed files
with
7,100 additions
and
0 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,49 @@ | ||
# .github/workflows/build.yml | ||
|
||
name: Build and Release | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
tags: [ 'v*' ] | ||
pull_request: | ||
branches: [ main ] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: '18' | ||
cache: 'npm' | ||
|
||
- name: Install dependencies | ||
run: npm ci | ||
|
||
- name: Build extension | ||
run: npm run build | ||
|
||
- name: Create ZIP archive | ||
run: | | ||
cd dist | ||
zip -r ../community-tldr.zip . | ||
- name: Upload build artifact | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: extension-build | ||
path: community-tldr.zip | ||
|
||
- name: Create Release | ||
if: startsWith(github.ref, 'refs/tags/v') | ||
uses: softprops/action-gh-release@v1 | ||
with: | ||
files: community-tldr.zip | ||
generate_release_notes: true | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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,31 @@ | ||
# Dependencies | ||
node_modules/ | ||
npm-debug.log | ||
yarn-debug.log | ||
yarn-error.log | ||
|
||
# Build | ||
dist/ | ||
build/ | ||
|
||
# IDE | ||
.idea/ | ||
.vscode/ | ||
*.swp | ||
*.swo | ||
|
||
# OS | ||
.DS_Store | ||
Thumbs.db | ||
|
||
# Environment | ||
.env | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
# Extension specific | ||
*.crx | ||
*.pem | ||
*.zip |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Community TL;DR Contributors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,85 @@ | ||
# Community TL;DR | ||
|
||
A Chrome extension that uses AI to summarize Hacker News discussions, providing quick insights into lengthy threads. | ||
|
||
## Features | ||
|
||
- 🤖 AI-powered discussion summarization | ||
- 📱 Support for Hacker News discussions | ||
- 🌐 Multiple language support (English, Chinese, Japanese, Korean) | ||
- 🔄 Custom AI endpoint configuration | ||
- 📊 Thread-level summaries | ||
- 🎯 Focused on key points and insights | ||
|
||
## Installation | ||
|
||
Since this extension is not yet available on the Chrome Web Store, you'll need to install it manually: | ||
|
||
1. Download the latest release from the [Releases](../../releases) page | ||
2. Unzip the downloaded file | ||
3. Open Chrome and navigate to `chrome://extensions/` | ||
4. Enable "Developer mode" in the top right corner | ||
5. Click "Load unpacked" and select the unzipped folder | ||
|
||
## Development Setup | ||
|
||
```bash | ||
# Clone the repository | ||
git clone https://github.com/yourusername/community-tldr.git | ||
cd community-tldr | ||
|
||
# Install dependencies | ||
npm install | ||
|
||
# Start development build with watch mode | ||
npm run dev | ||
|
||
# Build for production | ||
npm run build | ||
``` | ||
|
||
## Configuration | ||
|
||
1. After installation, click the extension icon and go to Settings | ||
2. Configure your preferred AI service: | ||
- Custom Endpoint (recommended) | ||
- OpenAI | ||
- Anthropic (Claude) | ||
- Cloudflare AI Worker | ||
3. Set your preferred summarization language | ||
4. Save settings and start using | ||
|
||
## Usage | ||
|
||
1. Visit any Hacker News discussion page | ||
2. Click the extension icon to show the summary sidebar | ||
3. Click "TL;DR" next to any thread to summarize it | ||
4. View summaries in the sidebar | ||
5. Click on summaries to jump to original comments | ||
|
||
## Building From Source | ||
|
||
```bash | ||
# Install dependencies | ||
npm install | ||
|
||
# Development build | ||
npm run dev | ||
|
||
# Production build | ||
npm run build | ||
|
||
# The built extension will be in the `dist` folder | ||
``` | ||
|
||
## Contributing | ||
|
||
1. Fork the repository | ||
2. Create your feature branch (`git checkout -b feature/AmazingFeature`) | ||
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) | ||
4. Push to the branch (`git push origin feature/AmazingFeature`) | ||
5. Open a Pull Request | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
Oops, something went wrong.