From 9349210a316055c9541be86cc1b39a3d1a1b11be Mon Sep 17 00:00:00 2001 From: Rey Bango Date: Sat, 8 Aug 2015 12:34:53 -0400 Subject: [PATCH] Updated README.md to be clearer on how to define the remote property in config.yaml --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5aa0d8a0..9be1355d 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,17 @@ Jingo needs a config file and to create a sample config file, just run `jingo -s This document contains also [the reference](#configuration-options-reference) for all the possible options. -If you define a `remote` to push to, then Jingo will automatically issue a push to that remote every `pushInterval` seconds. You can also specify a branch using the syntax "remotename branchname". If you don't specify a branch, Jingo will use `master`. Please note that before the `push`, a `pull` will also be issued (at the moment Jingo will not try to resolve conflicts, though). +If you define a `remote` to push to, then Jingo will automatically issue a push to that remote every `pushInterval` seconds. To declare a `remote` for Jingo to use, you'll need to identify the name of your local remote. The following example shows how a local remote is typically defined: + +`git remote add origin https://github.com/joeuser/jingorepo.git'` + +Based on that example, you would update config.yaml with the remote name "origin" as follows: + +`remote: "origin"` + +You can also use the `git remote` command to get the name of your remote. + +You can also specify a branch using the syntax "remotename branchname". If you don't specify a branch, Jingo will use `master`. Please note that before the `push`, a `pull` will also be issued (at the moment Jingo will not try to resolve conflicts, though). The basic command to run the wiki will then be