cuddle-please/docs/index.md

# Cuddle docs

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:

```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

```yaml
# ...
please:
  name: <something>  
  # ...
# ...
```

or as `cuddle.please.yaml`

See docs for more information about installation and some such