docs: include description of release command in readme

gembaadvantage · Nov 1, 2021 · 3fe7100 · 3fe7100
1 parent 3e6de79
commit 3fe7100
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -91,6 +91,14 @@ $ uplift bump
     • check and push any outstanding commits
 ```
 
+### Release
+
+A full semantic release will be carried out. Combining both the `bump` and `tag` operations, in that order.
+
+```sh
+uplift release
+```
+
 ## Configuration
 
 Uplift can be configured through the existance of an optional `.uplift.yml` configuration file in the root of your repository. Other supported variations are: `.uplift.yaml`, `uplift.yml` and `uplift.yaml`.