Add fish_prompt

README.md

@@ -1,6 +1,28 @@
 <h3 align="center">Starship ✨🚀</h3>
-<p align="center">The cross-platform prompt for astronauts.</p>
+<p align="center">The cross-shell prompt for astronauts.</p>
 
 ---
 
 This is very much work in progress, so please don't try to use it just yet!
+
+## Setup
+
+### Prerequisites
+
+- Rust v1.33 or higher
+- Fisher v3
+
+### Getting Started
+
+1. `cd` to the root of the **starship** repo
+1. Install the **starship** binary:
+
+    ```bash
+    cargo install --path .
+    ```
+
+1. Install the fish shell prompt with fisher:
+
+    ```bash
+    fisher $PWD
+    ```

fish_prompt.fish

@@ -0,0 +1,3 @@
+function fish_prompt
+  starship $status
+end

src/main.rs

@@ -13,7 +13,7 @@ use clap::{App, Arg};
 
 fn main() {
     let args = App::new("Starship")
-        .about("The cross-platform prompt for astronauts. ✨🚀")
+        .about("The cross-shell prompt for astronauts. ✨🚀")
         // pull the version number from Cargo.toml
         .version(crate_version!())
         // pull the authors from Cargo.toml

src/segment.rs

@@ -42,7 +42,7 @@ impl Segment {
     }
 
     /// Sets the style of the segment
-    /// 
+    ///
     /// Accepts either `Color` or `Style`.
     pub fn set_style<T>(&mut self, style: T) -> &mut Segment
     where