Release 0.5.0

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Foreman Changelog
+
+## 0.5.0
+- Initial release
+- Version number chosen so that Foreman can take over the [foreman](https://crates.io/crates/foreman) crate on crates.io and leave existing versions alone.

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "foreman"
 description = "Toolchain manager for simple binary tools"
-version = "0.1.0"
+version = "0.5.0"
 authors = ["Lucien Greathouse <[email protected]>"]
 license = "MIT"
 homepage = "https://github.com/rojo-rbx/foreman#readme"

README.md

@@ -5,24 +5,24 @@ Foreman is inspired by [rustup](https://rustup.rs) and [asdf](https://github.com
 
 It's an early prototype, but feedback at this stage is welcome!
 
-## Setup
-You'll need to build from source for now. Foreman builds on the latest stable version of Rust, currently 1.41.0.
+## Installation
+You can download pre-built Foreman releases for Windows, macOS, and Linux from the [Releases](https://github.com/rojo-rbx/foreman/releases) page.
 
-To install from the master branch, use:
+Alternatively, you can install from the `master` branch if you have [Rust](https://www.rust-lang.org/) 1.41.0 or newer installed:
 
 ```bash
 cargo install --git https://github.com/rojo-rbx/foreman.git
 ```
 
 On first run (try `foreman list`), Foreman will create a `.foreman` directory in your user folder (`~/.foreman` on Unix systems, `%USERPROFILE%/.foreman` on Windows).
 
-It's recommended that you add `~/.foreman/bin` to your `PATH`.
+It's recommended that you **add `~/.foreman/bin` to your `PATH`** to make the tools that Foreman installs for you accessible on your system.
 
 ## Usage
 Foreman downloads tools from GitHub and references them by their `user/repo` name, like `rojo-rbx/foreman`.
 
 ### System Tools
-To start using Foreman to manage your system's default tools, which will be used unless a project overrides them, create the file `~/.foreman/foreman.toml`.
+To start using Foreman to manage your system's default tools, create the file `~/.foreman/foreman.toml`.
 
 A Foreman config that lists Rojo could look like:
 
@@ -31,7 +31,7 @@ A Foreman config that lists Rojo could look like:
 rojo = { source = "rojo-rbx/rojo", version = "0.5.0" }
 ```
 
-Run `foreman install` from any directory to have Foreman pick up and install any tools listed in your system's Foreman config.
+Run `foreman install` from any directory to have Foreman pick up and install the tools listed in your system's Foreman config.
 
 Now, if you run `rojo` inside of a directory that doesn't specify its own version of Rojo, Foreman will run the most recent 0.5.x release for you!
 
@@ -49,10 +49,15 @@ Run `foreman install` to tell Foreman to install any new binaries from this conf
 
 When inside this directory, the `remodel` command will run the latest 0.6.x release of Remodel installed on your system.
 
+### Authentication
+To install tools from a private GitHub repository, Foreman supports authenticating with a [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
+
+Open `~/.foreman/auth.toml` after Foreman has run at least once to see instructions on how to set this up.
+
 ## Troubleshooting
-Foreman is a super early tool and has problems. Check out [the issue tracker](https://github.com/rojo-rbx/foreman/issues) for known bugs.
+Foreman is a work in progress tool and has some known issues. Check out [the issue tracker](https://github.com/rojo-rbx/foreman/issues) for known bugs.
 
-If you have issues with configuration, try deleting `~/.foreman` to start from scratch. This directory contains all of Foreman's installed tools and configuration.
+If you have issues with configuration, you can delete `~/.foreman` to delete all cached data and start from scratch. This directory contains all of Foreman's installed tools and configuration.
 
 ## License
 Foreman is available under the MIT license. See [LICENSE.txt](LICENSE.txt) or <https://opensource.org/licenses/MIT> for details.