diff --git a/README.md b/README.md index 052e992..e14e96b 100644 --- a/README.md +++ b/README.md @@ -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 " +``` + ## 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)