Skip to content

Update README.md Quick Start to reflect actual usage #34

@moshesham

Description

@moshesham

Problem

The README.md Quick Start guide shows commands that don't work:

# From README
python SQl_answer.py sql_basic_select

But SQl_answer.py doesn't accept command-line arguments in its current implementation.

Impact

  • New users cannot follow quick start guide
  • Poor first-time user experience
  • Misleading documentation
  • Frustration for contributors

Tasks

  • Decide on updating README or adding CLI support
  • Update README.md Quick Start section
  • Test all commands in README
  • Add troubleshooting section if needed
  • Add example output for each command
  • Update Docker usage examples if needed
  • Ensure prerequisites are accurate

Additional README Improvements

  • Add actual repository URL (currently shows placeholder)
  • Add screenshots or example output
  • Add FAQ section
  • Add troubleshooting guide

References

Metadata

Metadata

Assignees

Labels

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions