Add basic documentation

README.md

+# hggitforge
+
+Manage your Git fork with Mercurial
+
+Note: This tool is experimental
+
+## Installation
+
+### Install dependencies
+
+*hggitforge* depends on [Mercurial](https://www.mercurial-scm.org/), [Hg-Git](https://hg-git.github.io/) and [evolve](https://www.mercurial-scm.org/doc/evolution/)
+
+These can be installed using [pip](https://pip.pypa.io/en/stable/):
+
+```
+pip install --user mercurial hg-git hg-evolve
+```
+
+Add `~/.local/bin` to your `PATH` (for `hg` command)
+
+Enable *Hg-Git* in `~/.hgrc`:
+
+```
+[extensions]
+hgext.bookmarks =
+hggit =
+```
+
+Enable *evolve* in `~/.hgrc`:
+```
+[extensions]
+evolve =
+```
+
+### Install *hggitforge*
+
+```
+pip install --user -e .
+```
+
+Enable *hggitforge* in `~/.hgrc`:
+
+```
+[extensions]
+hggitforge =
+```
+
+## Usage
+
+You should configure your repository to delete Git branch on publication
+
+### Clone
+
+```
+hg gfclone <Git fork link> <Git upstream link> <directory name>
+```
+
+### Push branch
+
+```
+hg gfpush <Mercurial bookmark>
+```
+
+*Hg-Git* transforms a Git branch into a Mercurial Bookmark and vice versa
+
+### Pull
+
+```
+hg gfpull
+```
+
+Prunes deleted Git branches along with its associated Mercurial bookmark and its ancestors
+
+### Fetch remote branch
+
+```
+hg gfremote <remote Git link> <remote branch> <local bookmark>
+```