Skip to content

Latest commit

 

History

History
133 lines (92 loc) · 3.64 KB

README.md

File metadata and controls

133 lines (92 loc) · 3.64 KB

Volt

Rapid, reliable and robust Javascript package management.



WARNING: Volt is still in the development stage and is not ready for use!

Rapid: Volt is incredibly fast and powerful.

Reliable: Volt is built to be reliable and dependable.

Robust: Volt works with low resource usage.

Important: Volt is still in the alpha stage of development, and is not ready for use in production or development environments.

⚡ Installation

We don't have an official release of Volt yet, however, if you would like to give it a try, feel free to follow the steps below to build from source.

Build From Source

Prerequisites: Git, Rust Toolchain

Minimum Supported Rust Version (MSRV)

Rust 1.58

Steps

  1. Clone the github repository using the Github CLI.
git clone https://github.com/voltpkg/volt
  1. Change to the volt directory.
cd volt
  1. Run a compiled and optimized build
cargo run --release -- --help
# you should see a help menu from Volt

🧪 Testing

First, make sure you Build From Source.

Run this command to run the tests for volt.

cargo test

👏 Supporters

Stargazers repo roster for @voltpkg/volt

Forkers repo roster for @voltpkg/volt


🔨 Build Status

Feature Build Status
Add 🏗️
Audit
Cache
Check
Clone 🏗️
Compress 🏗️
Create 🏗️
Deploy 🏗️
Fix
Help 🏗️
Info
Init 🏗️
Install 🏗️
List 🏗️
Login 🏗️
Logout
Migrate 🏗️
Mod
Outdated
Owner
Ping 🏗️
Publish
Remove
Run 🏗️
Search
Set
Stat
Tag
Team
Update
Watch 🏗️

Built With

Rust

External Libraries

Versioning

We use semver for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under Apache-2.0 - see the LICENSE.md file for details.