Update README

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: lvl0/fedi-feed-router#47

myrmidex commented

2025-08-08 18:37:17 +02:00

(Migrated from codeberg.org)

Update readme to reflect this is a v1.0.0

Like this:

Own it. Add a clear README that says:

“This is a minimal working version — limited to two hardcoded sources, designed for self-hosters. Future versions will expand configurability and support.”

✅ README Improvement Checklist

🔰 1. Project Overview

One-liner: What does the app do?
Short paragraph: Why it exists / what problem it solves.

⚙️ 2. Features

Bullet list of current features (e.g. "Fetches articles from feed", "Keyword filtering", "Posts to Lemmy").
Optional: mention limitations or planned improvements (keep brief).

🚀 3. Installation

How to clone or install (Docker preferred? System deps?).
Any requirements (Python/PHP version, system tools, etc).
How to configure (e.g. .env, config file format, etc).

🕹️ 4. Usage

How to run it (CLI/Docker/cron).
Example commands.
Optional: sample config file or env var explanation.

📜 5. Logging & Debugging

Where logs go / what level of logging is default.
How to enable debug mode (if applicable).

🤝 6. Contributing

Link to CONTRIBUTING.md (if exists) or write 1-2 lines.
Encourage issue reports, PRs, etc.

📘 7. License

Clear license name (e.g. MIT, AGPLv3).
Link or paste license at bottom.

🧭 8. Roadmap / TODO (optional)

Link to milestones or list top planned features.

Update readme to reflect this is a v1.0.0 Like this: > Own it. Add a clear README that says: > > “This is a minimal working version — limited to two hardcoded sources, designed for self-hosters. Future versions will expand configurability and support.” ## ✅ README Improvement Checklist ### 🔰 1. Project Overview * [ ] One-liner: What does the app do? * [ ] Short paragraph: Why it exists / what problem it solves. ### ⚙️ 2. Features * [ ] Bullet list of current features (e.g. "Fetches articles from feed", "Keyword filtering", "Posts to Lemmy"). * [ ] Optional: mention limitations or planned improvements (keep brief). ### 🚀 3. Installation * [ ] How to clone or install (Docker preferred? System deps?). * [ ] Any requirements (Python/PHP version, system tools, etc). * [ ] How to configure (e.g. `.env`, config file format, etc). ### 🕹️ 4. Usage * [ ] How to run it (CLI/Docker/cron). * [ ] Example commands. * [ ] Optional: sample config file or env var explanation. ### 📜 5. Logging & Debugging * [ ] Where logs go / what level of logging is default. * [ ] How to enable debug mode (if applicable). ### 🤝 6. Contributing * [ ] Link to CONTRIBUTING.md (if exists) or write 1-2 lines. * [ ] Encourage issue reports, PRs, etc. ### 📘 7. License * [ ] Clear license name (e.g. MIT, AGPLv3). * [ ] Link or paste license at bottom. ### 🧭 8. Roadmap / TODO (optional) * [ ] Link to milestones or list top planned features.

Update README #47