Standardize README.md structure with correct AGPL-3.0 license #40
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
- Add comprehensive badges with correct AGPL-3.0 license (not Apache-2.0) - Restructure content following standardized template for consistency - Simplify and consolidate features into high-level bullets - Add SEMCL.ONE ecosystem integration section - Improve Quick Start section for immediate user value - Consolidate Usage section with clear CLI and API examples - Add Configuration section with environment variables - Add proper Contributing, Support, and Authors sections - Link to documentation (to be created) for detailed information - Remove redundant Status section at end - Follow PyPI and OSS documentation best practices This aligns src2purl documentation with other SEMCL.ONE projects while correctly reflecting its AGPL-3.0 license status.
oscarvalenzuelab
added
bug
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
Standardize src2purl README structure to align with other SEMCL.ONE projects, correctly displaying its AGPL-3.0 license (not Apache-2.0 like other projects).
Key Changes
License Badge Correction
Structure Improvements
Content Enhancements
Documentation Links
Why This Matters
Test Plan
License Note
This project uniquely uses AGPL-3.0 within the SEMCL.ONE ecosystem:
The README now correctly reflects this important distinction.