diff --git a/README.md b/README.md index 9a0d83f..d132d01 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,27 @@ A major design goal of `git-mirror` is that it should just work with as little c ## Get started -1. Download and extract the latest release from the [releases page](https://github.com/beefsack/git-mirror/releases). -1. Create `config.toml` similar to: +Download and extract the latest release from the [releases page](https://github.com/beefsack/git-mirror/releases). + +Create `config.toml` similar to: + ```toml [[repo]] Origin = "https://github.com/beefsack/git-mirror.git" ``` By default it will update the mirror every **15 minutes** and will serve the mirror over HTTP using port **8080**. You can specify as many repos as you want by having multiple `[[repo]]` sections. -1. Run `git-mirror` with the path to the config file: + +Run `git-mirror` with the path to the config file: + ```bash $ ./git-mirror config.toml 2015/05/07 11:08:06 starting web server on :8080 2015/05/07 11:08:06 updating github.com/beefsack/git-mirror.git 2015/05/07 11:08:08 updated github.com/beefsack/git-mirror.git ``` -1. Now you can clone from your mirror on the default port of `8080`: + +Now you can clone from your mirror on the default port of `8080`: + ```bash $ git clone http://localhost:8080/github.com/beefsack/git-mirror.git Cloning into 'git-mirror'...