Skip to content

Commit

Permalink
Add initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
extsoft committed Nov 24, 2017
1 parent 9d083db commit 08b78ee
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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.

6 comments on commit 08b78ee

@0pdd
Copy link

@0pdd 0pdd commented on 08b78ee Nov 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 9-5878affc disappeared from src/main/git-elegant, that's why I closed #39.

@0pdd
Copy link

@0pdd 0pdd commented on 08b78ee Nov 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 89-27642c68 discovered in CONTRIBUTING.md and submitted as #97.

@0pdd
Copy link

@0pdd 0pdd commented on 08b78ee Nov 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 89-d0540227 discovered in CONTRIBUTING.md and submitted as #98.

@0pdd
Copy link

@0pdd 0pdd commented on 08b78ee Nov 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 89-c39c3654 discovered in src/test/commons.bash and submitted as #99.

@0pdd
Copy link

@0pdd 0pdd commented on 08b78ee Nov 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 89-5ae02b5b discovered in src/test/commons.bash and submitted as #100.

@0pdd
Copy link

@0pdd 0pdd commented on 08b78ee Nov 24, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 89-c19177fa discovered in src/test/commons.bash and submitted as #101.

Please sign in to comment.