Update 'README.md'

This commit is contained in:
James 2019-09-07 11:02:08 +01:00
parent 429dedac4c
commit a629a17a82

View File

@ -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.