Update 'README.md'
This commit is contained in:
parent
cda81d95ae
commit
bb1e21db2e
14
README.md
14
README.md
@ -2,8 +2,20 @@
|
|||||||
Simple PHP library to interface with Gitea API
|
Simple PHP library to interface with Gitea API
|
||||||
|
|
||||||
Designed to make a "Bot" for manipulating labels on issues.
|
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
|
## 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
|
||||||
Usage example: [no_label_milestone.php](https://git.jhodges.co.uk/james/GiteaBot/src/branch/master/example)
|
Usage example: [no_label_milestone.php](https://git.jhodges.co.uk/james/GiteaBot/src/branch/master/example)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user