Skip to content

Commit d65b3d1

Browse files
madawei2699madawei2699
committed
first commit
0 parents  commit d65b3d1

24 files changed

+7100
-0
lines changed

‎.github/workflows/build.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# .github/workflows/build.yml
2+
3+
name: Build and Release
4+
5+
on:
6+
push:
7+
branches: [ main ]
8+
tags: [ 'v*' ]
9+
pull_request:
10+
branches: [ main ]
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v3
21+
with:
22+
node-version: '18'
23+
cache: 'npm'
24+
25+
- name: Install dependencies
26+
run: npm ci
27+
28+
- name: Build extension
29+
run: npm run build
30+
31+
- name: Create ZIP archive
32+
run: |
33+
cd dist
34+
zip -r ../community-tldr.zip .
35+
36+
- name: Upload build artifact
37+
uses: actions/upload-artifact@v3
38+
with:
39+
name: extension-build
40+
path: community-tldr.zip
41+
42+
- name: Create Release
43+
if: startsWith(github.ref, 'refs/tags/v')
44+
uses: softprops/action-gh-release@v1
45+
with:
46+
files: community-tldr.zip
47+
generate_release_notes: true
48+
env:
49+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Dependencies
2+
node_modules/
3+
npm-debug.log
4+
yarn-debug.log
5+
yarn-error.log
6+
7+
# Build
8+
dist/
9+
build/
10+
11+
# IDE
12+
.idea/
13+
.vscode/
14+
*.swp
15+
*.swo
16+
17+
# OS
18+
.DS_Store
19+
Thumbs.db
20+
21+
# Environment
22+
.env
23+
.env.local
24+
.env.development.local
25+
.env.test.local
26+
.env.production.local
27+
28+
# Extension specific
29+
*.crx
30+
*.pem
31+
*.zip

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Community TL;DR Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Community TL;DR
2+
3+
A Chrome extension that uses AI to summarize Hacker News discussions, providing quick insights into lengthy threads.
4+
5+
## Features
6+
7+
- 🤖 AI-powered discussion summarization
8+
- 📱 Support for Hacker News discussions
9+
- 🌐 Multiple language support (English, Chinese, Japanese, Korean)
10+
- 🔄 Custom AI endpoint configuration
11+
- 📊 Thread-level summaries
12+
- 🎯 Focused on key points and insights
13+
14+
## Installation
15+
16+
Since this extension is not yet available on the Chrome Web Store, you'll need to install it manually:
17+
18+
1. Download the latest release from the [Releases](../../releases) page
19+
2. Unzip the downloaded file
20+
3. Open Chrome and navigate to `chrome://extensions/`
21+
4. Enable "Developer mode" in the top right corner
22+
5. Click "Load unpacked" and select the unzipped folder
23+
24+
## Development Setup
25+
26+
```bash
27+
# Clone the repository
28+
git clone https://github.com/yourusername/community-tldr.git
29+
cd community-tldr
30+
31+
# Install dependencies
32+
npm install
33+
34+
# Start development build with watch mode
35+
npm run dev
36+
37+
# Build for production
38+
npm run build
39+
```
40+
41+
## Configuration
42+
43+
1. After installation, click the extension icon and go to Settings
44+
2. Configure your preferred AI service:
45+
- Custom Endpoint (recommended)
46+
- OpenAI
47+
- Anthropic (Claude)
48+
- Cloudflare AI Worker
49+
3. Set your preferred summarization language
50+
4. Save settings and start using
51+
52+
## Usage
53+
54+
1. Visit any Hacker News discussion page
55+
2. Click the extension icon to show the summary sidebar
56+
3. Click "TL;DR" next to any thread to summarize it
57+
4. View summaries in the sidebar
58+
5. Click on summaries to jump to original comments
59+
60+
## Building From Source
61+
62+
```bash
63+
# Install dependencies
64+
npm install
65+
66+
# Development build
67+
npm run dev
68+
69+
# Production build
70+
npm run build
71+
72+
# The built extension will be in the `dist` folder
73+
```
74+
75+
## Contributing
76+
77+
1. Fork the repository
78+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
79+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
80+
4. Push to the branch (`git push origin feature/AmazingFeature`)
81+
5. Open a Pull Request
82+
83+
## License
84+
85+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)