Skip to content

Commit ed02173

Browse files
committed
Quick writeup in the README
1 parent 54e3958 commit ed02173

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,10 @@ Node Web Git Proxy
33

44
This is a tool written with node.js to keep a directory up to date and checked out with the current versions on the remote server.
55

6-
This documentation is unfinished, the project doesn't even have any code written yet, so bug me to fix it later.
6+
You must create a `config.json` with at least a `repo` which points to a git repo, and a `title` which is used in the display. You may also change the output directory with `output` and the repo working area with `working`.
7+
8+
At that point, if you `grunt` it should clone the remote repo and start setting up a folder for each brach and tag.
9+
10+
If you create a file called `build-command.sh` it will be executed in the directory for each branch and tag after it is updated.
11+
12+
A `cron.sh` is provided to run `grunt cron` and surround it in a `.lock` check.

0 commit comments

Comments
 (0)