Skip to content

Add crates.io badges and installation instructions to README #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VrilLabs merged 1 commit into from
Jul 2, 2026
Merged

Add crates.io badges and installation instructions to README #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
# ☀️ Helios
> **JIT at the edge, blazing like the sun.**

[![Crates.io](https://img.shields.io/crates/v/vrillabs-helios.svg)](https://crates.io/crates/vrillabs-helios)
[![docs.rs](https://img.shields.io/docsrs/vrillabs-helios)](https://docs.rs/vrillabs-helios/1.2.0-rc1/helios/)
[![Crates.io downloads](https://img.shields.io/crates/d/vrillabs-helios.svg)](https://crates.io/crates/vrillabs-helios)
[![License](https://img.shields.io/badge/license-VRIL%20LABS%20Open%20Source-blue.svg)](LICENSE)

Helios is an alpha-stage JavaScript runtime written in Rust for edge and serverless-style workloads. It provides a lock-free worker dispatcher, a shared bytecode cache, Hyper-based HTTP/1.1 + HTTP/2 serving, optional QUIC/HTTP/3 and WebTransport support, and a built-in benchmark harness.

The default build is self-contained: it embeds a pure-Rust Boa JavaScript engine, so it runs without any external JavaScript toolchain. An experimental SpiderMonkey/Ion backend is scaffolded behind a feature flag but is not yet production-ready.
Expand Down Expand Up @@ -34,6 +39,32 @@ cargo build --release -p helios
./target/release/helios serve ../bench/helios-simple.js --port 8080
```

## Metadata

Helios is published on [crates.io](https://crates.io/crates/vrillabs-helios) as `vrillabs-helios`.

```sh
cargo install vrillabs-helios
```

Running the above command will globally install the `helios` binary.

### Install as library

Run the following Cargo command in your project directory:

```sh
cargo add vrillabs-helios
```

Or add the following line to your `Cargo.toml`:

```toml
vrillabs-helios = "1.2.0-rc1"
```

Full API documentation is available on [docs.rs](https://docs.rs/vrillabs-helios/1.2.0-rc1/helios/).

## Current capabilities

| Area | Current status |
Expand Down