From a629a17a820eed3bee685c03c879886d8ecc2dba Mon Sep 17 00:00:00 2001 From: James Date: Sat, 7 Sep 2019 11:02:08 +0100 Subject: [PATCH] Update 'README.md' --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9b65c2..d54fc38 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ Examples for [jhodges/GiteaBot](https://git.jhodges.co.uk/jhodges/GiteaBot) -Copy [src/config.php.dist](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/config.php.dist) to src/config.php and set your Gitea instalce URL and bots user/pass. +## Install + +1. Clone or download and unpack this repo. +2. Do a `composer install` +3. Copy [src/config.php.dist](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/config.php.dist) to src/config.php and set your Gitea instalce URL and bots user/pass. + +## Examples All examples include [src/setup.php](https://git.jhodges.co.uk/jhodges/GiteaBot-examples/src/branch/master/src/setup.php) which loads the autoloader and config, connects to the Gitea instance specified in config, passes the command line args, and opens the repo specified on command line. After this $client and $repo will be available.