Fix license badge and add complete documentation #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Correct license badge from MIT to Apache-2.0 (matching actual LICENSE file) - Add comprehensive documentation directory with three guides: - user-guide.md: PURL concepts, usage, ecosystems, troubleshooting - api.md: Python API reference with functions and classes - examples.md: Ecosystem-specific examples and integration workflows - Documentation includes batch processing and CI/CD integration - Provides Docker, Makefile, and automation examples - All documentation files referenced in README now exist This ensures the project has accurate licensing information and complete documentation as promised in the README structure.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR completes the documentation improvements by:
Changes Made
License Correction
Documentation Added
Created comprehensive documentation in
docs/directory:Documentation Features
Why These Changes Are Important
License Accuracy: The project uses Apache-2.0 license, not MIT. Having incorrect badges creates confusion and potential legal issues.
Documentation Completeness: The README referenced documentation files that didn't exist. This PR creates all referenced documentation.
Developer Experience: Provides comprehensive guides for using both CLI and Python API effectively.
Test Plan
Related Issues
Completes the README standardization and ensures all referenced documentation exists.