diff options
author | Matan Kushner <hello@matchai.me> | 2019-07-10 13:09:45 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-10 13:09:45 -0400 |
commit | 67537ae753ce4db59b4c0378508493bc63f694a8 (patch) | |
tree | c962bc9e2df17686ebeee70878e28cb81e78c894 | |
parent | d7754f38e7959bd2d16406913c6776ad7c6ac8d6 (diff) |
chore: Publish crate to Crates.io (#92)
* Add all the necessary Cargo.toml details for crates.io
* Update the image on README.md to be a full URL so crates.io can load it
* Update installation instructions to encourage installing from crates.io
-rw-r--r-- | Cargo.lock | 2 | ||||
-rw-r--r-- | Cargo.toml | 18 | ||||
-rw-r--r-- | README.md | 13 |
3 files changed, 25 insertions, 8 deletions
diff --git a/Cargo.lock b/Cargo.lock index 9cf6f5b15..ea905cc1d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -702,7 +702,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" [[package]] name = "starship" -version = "0.1.0" +version = "0.1.0-beta.4" dependencies = [ "ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)", "battery 0.7.4 (registry+https://github.com/rust-lang/crates.io-index)", diff --git a/Cargo.toml b/Cargo.toml index 230048f9f..8b79a77f4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,22 @@ [package] name = "starship" -version = "0.1.0" -authors = ["Matan Kushner <hello@matchai.me>"] +version = "0.1.0-beta.4" edition = "2018" +authors = ["Matan Kushner <hello@matchai.me>"] +repository = "https://github.com/starship/starship" +readme = "README.md" +license = "ISC" +keywords = ["prompt", "shell", "bash", "fish", "zsh"] +categories = ["command-line-utilities"] +description = """ +The cross-shell prompt for astronauts. ☄🌌️ +""" + +[badges] +azure-devops = { project = "starship-control/starship", pipeline = "Starship Test Suite" } +is-it-maintained-issue-resolution = { repository = "starship/starship" } +is-it-maintained-open-issues = { repository = "starship/starship" } +maintenance = { status = "actively-developed" } [dependencies] clap = "2.33.0" @@ -1,7 +1,8 @@ <h1 align="center"> <br> - <img width="400" src="media/logo.png" alt="Starship – Cross-shell prompt"> + <img width="400" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" alt="Starship – Cross-shell prompt"> <p align="center"> + <a href="https://crates.io/crates/starship"><img src="https://badgen.net/crates/v/starship" alt="Crates.io version"></a> <a href="https://dev.azure.com/starship-control/starship/_build"><img src="https://badgen.net/azure-pipelines/starship-control/starship/Starship%20Test%20Suite" alt="Azure Pipelines Build Status"></a> <a href="#contributors"><img src="https://badgen.net/badge/all%20contributors/7/orange" alt="All Contributors"></a> <a href="https://discord.gg/8Jzqu3T"><img src="https://badgen.net/badge/chat/on%20discord/7289da" alt="Chat on Discord"></a> @@ -9,7 +10,7 @@ <br> </h1> -> ⚠️ This is very much work in progress, so please don't try to use it just yet! +> ⚠️ Starship is still a work in progress but is now far enough along to be used as a prompt (I personally use it as my daily driver) Starship is a Rust port of the minimalistic, powerful, and extremely customizable prompt [Spaceship ZSH](https://github.com/denysdovhan/spaceship-prompt). @@ -80,12 +81,10 @@ I'm very new to Rust, so any help is appreciated when it comes to improving deve ### Getting Started -1. `cd` to the root of the **starship** repo - 1. Install the **starship** binary: ```bash - cargo install --path . + cargo install starship ``` 1. Add the init script to your shell's config file: @@ -110,6 +109,10 @@ I'm very new to Rust, so any help is appreciated when it comes to improving deve eval (starship init fish) ``` +## Configuration + +> 🚧 Configuration features and documentation are in the process of being developed + ## Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): |