Files
gh-action-readme/docs

Documentation

Welcome to the gh-action-readme documentation! This directory contains comprehensive guides for using and developing the tool.

📖 User Documentation

  • Installation - Installation methods and package managers
  • Usage - Comprehensive usage examples and CLI reference
  • Configuration - Config files, environment variables, and settings
  • Themes - Available themes, customization, and examples

🔧 Developer Documentation

  • Development - Development setup, testing, and contribution guide
  • Security - Security practices, vulnerability reporting, and policies
  • API Reference - Detailed CLI command reference

🚀 Project Information

  • Roadmap - Future plans and strategic initiatives

🤝 Getting Help

  • Check the relevant documentation section above
  • Browse the GitHub Issues
  • See the main README.md for quick start information

For the latest updates and announcements, see the CHANGELOG.md.