Skip to content

Add More CLI Examples to README #24

@Virviil

Description

@Virviil

Description

Expand the README with more real-world usage scenarios, edge cases, and comprehensive examples to help users understand all the capabilities of oci2git.

Tasks

  • Add examples for different image types (Alpine, Ubuntu, multi-stage builds)
  • Include examples with different output formats and options
  • Add troubleshooting section with common issues and solutions
  • Document environment variable usage with examples
  • Add examples for multi-image analysis workflows
  • Include performance tips and best practices
  • Add examples for different container engines (docker, nerdctl, tar)

Skills Required

  • Markdown formatting
  • Docker/container knowledge helpful
  • Technical writing

Sections to Enhance

  • Expand "Examples" section with more scenarios
  • Add "Troubleshooting" section
  • Add "Advanced Usage" section
  • Include "Performance Tips" section

Example Scenarios to Cover

  • Converting large images (>1GB)
  • Analyzing multi-stage Docker builds
  • Working with private registries (when auth is implemented)
  • Comparing similar images from different bases
  • Using with CI/CD pipelines

Resources

  • Current README.md as reference
  • Docker documentation for realistic examples

This is a perfect good first issue for Hacktoberfest! 🎃

Hacktoberfest 2025 🍂

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomershacktoberfestIssues perfect for Hacktoberfest contributions

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions