Add crates.io badges and installation instructions to README#19
Merged
Conversation
Copilot created this pull request from a session on behalf of
VrilLabs
July 2, 2026 11:37
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository README to better reflect the crate’s availability on crates.io by adding badges and installation guidance.
Changes:
- Added crates.io, docs.rs, download count, and license badges under the title.
- Added a “Metadata” section with
cargo installinstructions for the CLI. - Added “Install as library” instructions via
cargo addand aCargo.tomlsnippet, plus a docs.rs link.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > **JIT at the edge, blazing like the sun.** | ||
|
|
||
| [](https://crates.io/crates/vrillabs-helios) | ||
| [](https://docs.rs/vrillabs-helios/1.2.0-rc1/helios/) |
| cargo install vrillabs-helios | ||
| ``` | ||
|
|
||
| Running the above command will globally install the `helios` binary. |
| vrillabs-helios = "1.2.0-rc1" | ||
| ``` | ||
|
|
||
| Full API documentation is available on [docs.rs](https://docs.rs/vrillabs-helios/1.2.0-rc1/helios/). |
| [](https://crates.io/crates/vrillabs-helios) | ||
| [](https://docs.rs/vrillabs-helios/1.2.0-rc1/helios/) | ||
| [](https://crates.io/crates/vrillabs-helios) | ||
| [](LICENSE) |
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.
The README lacked GitHub badges and setup instructions for the crate now published on crates.io.
Badges
Metadata / installation section
cargo install vrillabs-heliosfor the CLI binary.cargo add vrillabs-heliosand the equivalentCargo.tomlentry.