diff --git a/README.md b/README.md index e06751b..e375b10 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ # Cuddle Please -Cuddle Please is an extension to `cuddle`, it is a separate binary that can be executed standalone as cuddle-please, or in cuddle as `cuddle please`. +Cuddle Please is an extension to `cuddle`, it is a separate binary that can be executed standalone as `cuddle-please`, or in cuddle as `cuddle please`. The goal of the software is to be a `release-please` clone, targeting `gitea` instead of `github`. The tool can be executed as a binary using: -`cuddle please pr create` +```bash +cuddle please release # if using cuddle +# or +cuddle-please release # if using standalone +``` And when a release has been built: ```bash cuddle please release +# or +cuddle-please release ``` cuddle will default to information to it available in git, or use a specific entry in `cuddle.yaml` called @@ -28,7 +34,6 @@ or as `cuddle.please.yaml` See docs for more information about installation and some such - ## Checklist ### 0.1 Milestone