diff --git a/README.md b/README.md index 3f476c3..a003d81 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ -# My Dotfiles - main +# My Dotfiles -Dotfiles that represent the shared scripts and configs across all shells and hosts +Dotfiles that represent the shared scripts and configs across all shells and hosts. Leverages the +`store` Go application to reconcile symlinks and organize configurations in the home directory. + +On any new machine, clone the repo: + +```sh +git clone +cd dotfiles +``` + +Download a pre-built binary at [github.com/cushycush/store](https://github.com/cushycush/store/releases) +or follow install instructions [here](https://github.com/cushycush/store#installation). + +Then simply run the `store` command that reads the config file and applies all changes: + +```sh +store apply + +# or interactively +store tui +```