release v1.0.0

README.md

@@ -1,6 +1,5 @@
 # dotbare
 
-[![Build Status](https://img.shields.io/travis/com/kazhala/dotbare/master?label=Travis&logo=Travis)](https://travis-ci.com/kazhala/dotbare)
 ![CI Status](https://github.com/kazhala/dotbare/workflows/CI/badge.svg)
 ![AWSCodeBuild](https://codebuild.ap-southeast-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiYWVnOEdGbWxuMmpJdVF2S3RTOFdUeGhEZDZvVkZ1cnBtZGJjd0RuOFdxUWxGeG1zR2YycFcydFJZT25VV3NkZnNsRWJ4ZVNsZ0VxZnpOY3RFUGdMV0RNPSIsIml2UGFyYW1ldGVyU3BlYyI6IlNDNjNHTlkyS2ZmbE5lZGIiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
 ![Platform](https://img.shields.io/badge/platform-macos%20%7C%20linux-blue)
@@ -62,24 +61,25 @@ with minimal set up required.
     - [Migrating dotbare to a new system](#migrating-dotbare-to-a-new-system)
     - [Test it in docker](#test-it-in-docker)
 - [Customization](#customization)
-  - [DOTBARE_DIR](#dotbare_dir)
-  - [DOTBARE_BACKUP](#dotbare_backup)
-  - [EDITOR](#editor)
-  - [DOTBARE_KEY](#dotbare_key)
-  - [DOTBARE_FZF_DEFAULT_OPTS](#dotbare_fzf_default_opts)
+  - [DOTBARE_DIR: location of the git directory](#dotbare_dir)
+  - [DOTBARE_TREE: location of the working index](#dotbare_key)
+  - [DOTBARE_BACKUP: location to backup files](#dotbare_backup)
+  - [EDITOR: editor used to open files](#editor)
+  - [DOTBARE_KEY: keybinds](#dotbare_key)
+  - [DOTBARE_FZF_DEFAULT_OPTS: fzf customization](#dotbare_fzf_default_opts)
 - [Commands](#commands)
   - [Checkout all available scripts and their help manual](#checkout-all-available-scripts-and-their-help-manual)
-  - [fedit](#fedit)
-  - [fadd](#fadd)
-  - [freset](#freset)
-  - [fcheckout](#fcheckout)
-  - [flog](#flog)
-  - [fstash](#fstash)
-  - [fbackup](#fbackup)
-  - [fstat](#fstat)
-  - [finit](#finit)
-  - [funtrack](#funtrack)
-  - [fupgrade](#fupgrade)
+  - [fedit: edit dotfiles](#fedit)
+  - [fadd: stage changes](#fadd)
+  - [freset: unstage changes](#freset)
+  - [fcheckout: discard changes/checkout commits and branch](#fcheckout)
+  - [flog: interactive log viewer](#flog)
+  - [fstash: stash management](#fstash)
+  - [fbackup: backup tracked files](#fbackup)
+  - [fstat: toggle stage/unstage files](#fstat)
+  - [finit: initialise/migrating dotbare](#finit)
+  - [funtrack: untrack files](#funtrack)
+  - [fupgrade: update dotbare](#fupgrade)
 - [Tips and Tricks](#tips-and-tricks)
 - [Testing](#testing)
 - [Contributing](#contributing)