Update README with project description, docs links, and centered logo#49
Merged
Update README with project description, docs links, and centered logo#49
Conversation
…d install instructions - Center the chameleon logo using HTML <p align="center"> - Fix OCI link typo (opencoutnaiers.org -> opencontainers.org) - Clarify dual-mode usage: standard mode and expert/break mode - Add Installation section (clone + pip install -e .) - Add Quick Start section with ping, manifest get, and tag list examples - Add Documentation section linking to guides, architecture, CLI specs, and library specs - Add Contributing, Security, and License sections - Retain early development disclaimer Closes #48
Contributor
There was a problem hiding this comment.
Pull request overview
This PR overhauls the repository README to provide a clearer project description, fix a typo in the OCI link, center the logo, and add Installation, Quick Start, Documentation, Contributing, Security, and License sections. It closes issue #48.
Changes:
- Fixed OCI URL typo and improved project description with dual-mode explanation and bold name-origin highlights
- Centered the logo using HTML and added new sections (Installation, Quick Start, Documentation, Contributing, Security, License)
- Added a Documentation section with links to guides, architecture, CLI command specs (table), and library specs
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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
Overhauls the repository README to better describe the project, link to specs and documentation, and improve the visual layout.
Closes #48
Changes
Visual Layout
<p align="center">withwidth="256"Project Description
opencoutnaiers.org→opencontainers.org)New Sections
pip install -e .(pip install not yet available)ping,manifest get, andtag listRetained