From 50db78f9d38d4a16dfb44689b7eba6b8fa54da6b Mon Sep 17 00:00:00 2001 From: Salt Date: Tue, 10 Nov 2020 09:57:29 -0600 Subject: [PATCH] Fix up our README a bit --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 41bee7a..201e355 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Salt's Bootstrap Script -## Usage +A script to bootstrap a user with git and some auxiliary tools. -### Dotfiles +## Usage Download and run the latest `bootstrap.sh`: @@ -16,10 +16,12 @@ In the event that you want to simply test `bootstrap.sh`, simply pass a differen See `bootstrap.sh -h` for more usage information. -### Older Versions +## Older Versions `build-home.sh` is an older version of the script kept here for legacy compatibility. Do not use it; use `bootstrap.sh`. ## Notes + * By default, the user's home directory will be bootstrapped. Passing `-d` and a different path will cause a different path to be bootstrapped. + * By default, the repository will be cloned over SSH. Either generate some keys and add them to your remote server or change the repository URI to HTTP.