jhodges/GiteaBot
1
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
James 2019-08-25 10:45:41 +01:00
parent cda81d95ae
commit bb1e21db2e
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,8 +2,20 @@
Simple PHP library to interface with Gitea API
Designed to make a "Bot" for manipulating labels on issues.
## Create New Project (optional)
You only need to do this if you dont already have a composer project.
```bash
mkdir bot
cd bot
composer init -n --name "acme/bot" --description "my bot!" --author "Me <me@example.com>"
```
## Install
composer create-project -s dev jh/giteabot --repository-url 'https://git.jhodges.co.uk/composer/'
```bash
composer config repositories.repo-name vcs https://git.jhodges.co.uk/composer/
composer require jh/giteabot:dev-composer
```
## Usage
Usage example: [no_label_milestone.php](https://git.jhodges.co.uk/james/GiteaBot/src/branch/master/example)