From 6d24f67490fca0679b7087663335ec3d61b5134a Mon Sep 17 00:00:00 2001 From: kevin zhuang Date: Sun, 17 May 2020 15:38:31 +1000 Subject: [PATCH] include a demo gif --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index b4165d9..a37213d 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,12 @@ Core characteristics: - Minimal dependency - 1 step migration - Zero learning curve +- Manage dotfiles in any directory You could find out how git bare repository could be used for managing dotfiles [here](https://www.atlassian.com/git/tutorials/dotfiles). +![Demo](../assets/demo.gif?raw=true) + ## Why It has always been a struggle for me to get started with managing dotfiles using version control, @@ -159,6 +162,24 @@ dotbare finit -u [URL] ## Usage +> dotbare doesn't have a man page yet, will come later, for help, type dotbare [COMMANDS] -h + +### Checkout all available scripts and their help manual + +```sh +# run dotbare without any arguments +dotbare +# or checkout help for dotbare +dotbare -h +dotbare help +# for normal git help +dotbare --help +``` + +### dotbare fadd + +interactivly stage and view changes for modified files + ## Background dotbare was initially part of my personal scripts, however as the number of scripts grows,