diff --git a/docs/README.md b/docs/README.md index e69de29..253a728 100644 --- a/docs/README.md +++ b/docs/README.md @@ -0,0 +1,51 @@ +Elegant git +=========== +Your `git` experience will be changed forever. + +Philosophy +---------- +- declarative interaction +- no merge commits + +Limitations +----------- +Support only one default remote - `origin`. + +Commands +-------- +### feature +Creates a new branch based on `master`. If there are some uncommitted changes, they will be moved to the new branch. + +### pull +Downloads new updates for a local branch. + +### push +Upload current local branch to a remote one. If the remote branch is absent, it will be created. + +### rebase +Reapplies commits on top of the latest `origin/master`. + +### push-after-rebase +Executes [git elegant push](#push) after [git elegant rebase](#rebase). + +### init +Creates an empty Git repository or reinitialize an existing one. Then runs local repository configuration. + +### clone +Clone a repository into a new directory. Then runs local repository configuration. + +### add +Adds file contents to the index interactively. + +### clear-local +Removes all local branches which don't have remote tracking branches. + +### configure +Defines some settings for both _global_ and _local_ `git config`. + +### check +Shows trailing whitespaces of uncommitted changes. + +### commands +Displays all available commands. +