diff --git a/README.md b/README.md index 806664d..f0a1c64 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,20 @@ AutoDeploy is a tool written in 100% bash that allows for extensible synchroniza I work on so many different machines that keeping my configuration files and the versions of the software I use in sync between many machines is a painstaking task. Autodeploy should help with the following: - Easily moving all configuraiton files (`~/.vimrc`,`~/.config/i3/config`,`~/.xprofile`,etc) between multiple machines -- Keeping software (and their configurations) the same across all machines - 100% bash -- [Trufflehog](https://github.com/trufflesecurity/trufflehog)-like functionality for configuration files being stored in public places (IE: Github) +- [Trufflehog](https://github.com/trufflesecurity/trufflehog)-like functionality for configuration files being stored in public places (IE: Github) + +# Features +- Pulling down of files from remote repository +- Pushing of files to a remote repository +- *Staging* of files defined in `global_dotFiles.conf` into `~/.config/autodeploy/$(hostname)_config/` +- Distributing config files in `$(hostname)_config/` to their correct locations +- Backing up of local configuration files to `~/.config/autodeploy/$(hostname)_config/backup/` before overwriting them +- Installing of any application defined in `global_applications` # Documentation -`global_applicaitons.conf` -> The names of applications you wish to install via apt +`global_applications.conf` -> The names of applications you wish to install via apt ```markdown neovim