Skip to content

docs(readme): improve getting started guide and add quick 60-second s…#6

Closed
Techikrish wants to merge 1 commit into
developfrom
docs/improve-getting-started-guide
Closed

docs(readme): improve getting started guide and add quick 60-second s…#6
Techikrish wants to merge 1 commit into
developfrom
docs/improve-getting-started-guide

Conversation

@Techikrish

Copy link
Copy Markdown
Owner

…etup

  • Reorganize installation and getting started sections for clarity
  • Add step-by-step Quick Start guide with 60-second setup time
  • Include practical example of how to test the tool
  • Add example output showing what users see when secrets are detected
  • Update CONTRIBUTING.md with dev tools explanation
  • Add pro tip about [dev] extras in development setup section

These changes make it easier for new users to get started quickly and understand how the tool works in practice.

Description

Related Issue

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 📚 Documentation update
  • 🔧 Chore (CI/CD, dependencies, configuration)

Testing

  • Tests added/updated
  • All 92 tests passing locally
  • Code coverage > 80%

Test command:

pytest tests/ -v

Checklist

  • My code follows the PEP 8 style guide
  • I have performed a self-review of my own code
  • I have added tests for new functionality
  • All new and existing tests pass
  • I have updated documentation (if needed)
  • My changes do not introduce breaking changes
  • PR targets develop branch (not main)

Additional Context

…etup

- Reorganize installation and getting started sections for clarity
- Add step-by-step Quick Start guide with 60-second setup time
- Include practical example of how to test the tool
- Add example output showing what users see when secrets are detected
- Update CONTRIBUTING.md with dev tools explanation
- Add pro tip about [dev] extras in development setup section

These changes make it easier for new users to get started quickly
and understand how the tool works in practice.
@Techikrish Techikrish closed this Jan 1, 2026
@Techikrish
Techikrish deleted the docs/improve-getting-started-guide branch January 1, 2026 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant