Commit Graph

4 Commits

Author SHA1 Message Date
Guillem Hernandez Sola
8a514ed97b README and ca 2026-05-20 11:41:30 +02:00
Guillem Hernandez Sola
40b379e261 docs: Revamp README with comprehensive documentation and troubleshooting guides
- Add quick start section with 3-step setup instructions
- Include prerequisites and platform compatibility information
- Expand credentials configuration with security best practices
- Add detailed configuration section with media constraints table
- Provide concrete usage examples for RSS, Twitter daemon, and systemd
- Include cron job integration examples for scheduling
- Add project structure diagram showing all key files and directories
- Create extensive troubleshooting section with common issues and solutions
- Add debugging guide with log analysis tips
- Include FAQ section addressing typical user questions
- Document use cases and real-world scenarios
- Add security notes for credential management
- Improve contributing guidelines with step-by-step workflow
- Enhance formatting with emojis, tables, and better organization
- Replace vague descriptions with actionable, specific guidance

This makes the documentation suitable for both beginner and advanced users while providing clear paths for setup, usage, and troubleshooting.

Co-authored-by: Copilot <copilot@github.com>
2026-04-28 06:56:13 +02:00
Guillem Hernandez Sola
6fdd588179 Added new yml 2026-04-05 09:04:46 +02:00
Guillem Hernandez Sola
57bf1aab81 chore: update and merge gitignore 2026-03-29 17:44:14 +02:00