Skip to content

Commit 44c5db4

Browse files
committed
polish README.md
1 parent d8bea71 commit 44c5db4

1 file changed

Lines changed: 2 additions & 93 deletions

File tree

README.md

Lines changed: 2 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# PostgreSQL Weekly - A Hacker's Digest
22

3-
> A technical blog aggregating and analyzing discussions from PostgreSQL mailing lists, powered by Cursor Agent.
3+
> A technical blog aggregating and analyzing discussions from [pgsql-hackers](https://www.postgresql.org/list/pgsql-hackers/), powered by Cursor Agent.
44
55
[![mdBook](https://img.shields.io/badge/built%20with-mdBook-blue)](https://rust-lang.github.io/mdBook/)
66
[![Cursor AI](https://img.shields.io/badge/powered%20by-Cursor%20AI-purple)](https://cursor.sh/)
7-
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-Mailing%20Lists-336791)](https://www.postgresql.org/list/)
87

98
## 🎯 Project Overview
109

@@ -15,46 +14,11 @@ This project automates the process of:
1514
4. **Generating** high-quality technical blog posts using AI (Cursor Agent)
1615
5. **Publishing** organized weekly digests using mdBook
1716

18-
## 🚀 Quick Start
19-
20-
### Prerequisites
21-
22-
- Python 3.7+
23-
- mdBook (for building the site)
24-
- Optional: `html2text` for better Markdown conversion
25-
```bash
26-
pip install html2text
27-
```
28-
29-
### Setup
30-
31-
1. **Clone the repository**
32-
```bash
33-
git clone <your-repo-url>
34-
cd pgweekly
35-
```
36-
37-
2. **Create your prompt file** (first time only)
38-
```bash
39-
cp QUICK_PROMPT.template QUICK_PROMPT.txt
40-
```
41-
> **Important:**
42-
> - `QUICK_PROMPT.template` is the version-controlled template
43-
> - `QUICK_PROMPT.txt` is your personal working copy (gitignored)
44-
> - Always copy from the template when starting fresh
45-
> - You can customize `QUICK_PROMPT.txt` without affecting the repository
46-
47-
3. **Build the book** (optional, to view existing content)
48-
```bash
49-
mdbook build
50-
mdbook serve # View at http://localhost:3000
51-
```
52-
5317
## 📝 Workflow: From Thread to Blog
5418

5519
### Step 1: Find a Thread
5620

57-
Visit [PostgreSQL Mailing Lists](https://www.postgresql.org/list/) and find an interesting discussion. Copy the thread URL or ID.
21+
Visit [pgsql-hackers](https://www.postgresql.org/list/pgsql-hackers/) and find an interesting discussion. Copy the thread URL or ID.
5822

5923
Example URL:
6024
```
@@ -241,61 +205,6 @@ git commit -m "Add blog: [topic]"
241205
git push
242206
```
243207

244-
## 📖 Advanced Topics
245-
246-
### Batch Processing
247-
248-
Process multiple threads at once:
249-
250-
```bash
251-
# Fetch multiple threads
252-
for thread_id in "id1" "id2" "id3"; do
253-
python3 tools/fetch_data.py --thread-id "$thread_id"
254-
done
255-
```
256-
257-
Then use the batch processing prompt in `BLOG_GENERATION_PROMPT.md`.
258-
259-
### Custom Prompts
260-
261-
Customize `QUICK_PROMPT.txt` for your needs:
262-
- Adjust writing style (formal, conversational)
263-
- Focus on specific aspects (performance, security)
264-
- Target specific audiences (DBAs, developers, beginners)
265-
- Change blog length or depth
266-
267-
### Comparing Patches
268-
269-
When multiple patch versions exist (v1, v2, v3), the agent will automatically:
270-
```bash
271-
diff -u attachments/v1-*.patch attachments/v2-*.patch
272-
```
273-
274-
This helps explain how the solution evolved based on community feedback.
275-
276-
## 🎓 Learning Resources
277-
278-
- [PostgreSQL Mailing Lists](https://www.postgresql.org/list/)
279-
- [mdBook Documentation](https://rust-lang.github.io/mdBook/)
280-
- [PostgreSQL Documentation](https://www.postgresql.org/docs/)
281-
282-
## 🤝 Contributing
283-
284-
1. Fork the repository
285-
2. Create your feature branch
286-
3. Follow the existing content structure
287-
4. Submit a pull request
288-
289208
## 📄 License
290209

291210
See [LICENSE](LICENSE) file for details.
292-
293-
## 🙏 Acknowledgments
294-
295-
- PostgreSQL community for the valuable mailing list discussions
296-
- Cursor AI for powering the blog generation
297-
- mdBook for the excellent static site generator
298-
299-
---
300-
301-
**Pro Tip:** Keep `QUICK_PROMPT.txt` customized for your workflow, but always refer back to `QUICK_PROMPT.template` for the latest structure and improvements.

0 commit comments

Comments
 (0)