how-to-release.md: Fix "git push" command

[ansible-collection-boilerplate.git] / README.md

diff --git a/README.md b/README.md
index 12f35bd30d211b02d4fdfbdedf9efa9775505d5d..7fd69ebb9627038f8aff28b31325cfecbbe3d88c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ environment variable to:
   `/usr/local/src/ansible-collection-boilerplate.git`)
 * a URL to a remote Git repository (e. g.
   `git+https://my.git.server/ansible-collection-boilerplate.git`)
-* the name of an Collection stored on the Ansible Galaxy (e. g.
+* the name of a collection stored on the Ansible Galaxy (e. g.
   `alexbarton.boilerplate`)
 
 Example:
@@ -78,6 +78,7 @@ code repository. For Git, something like this:
 ```bash
 git init
 git add .
+git status --no-column
 git commit -m "Initial commit"
 ```
 
@@ -97,3 +98,17 @@ system provided by this project, you can just use the `make` command itself:
 ```bash
 make upgrade
 ```
+
+## Upgrade vs. Update
+
+Updating an existing project, either with `./bin/ansible-boilerplate update` or
+by calling `make update`, means to fulfill all Python dependencies in
+`requirements.txt` and all Ansible Galaxy dependencies in `requirements.yml` by
+trying to install the latest/newest compatible versions. Ansible Boilerplate
+scripts are updated (overwritten) with their current versions; configuration is
+left unchanged.
+
+The `./bin/ansible-boilerplate upgrade` or `make upgrade` command do the same
+and additionally install new, missing and updated Ansible Boilerplate
+configuration files. Existing configuration files are not overwritten, new
+versions are installed with the ".new" file extension.