Merge branch 'baseimagedocs' into 'main'

Docs improvements

Closes #15

See merge request larswirzenius/vmadm!20

2 files changed, 14 insertions, 1 deletions

diff --git a/NEWS b/NEWS
index 20cdc60..b64b2b5 100644
--- a/NEWS
+++ b/NEWS
@@ -6,7 +6,11 @@ from release to release.
 
 ## Version 0.2.0+git, NOT YET RELEASED
 
-This is an unreleased version being developed.
+This is a bug fix release. Previously, a VM created by vmadm had the
+cloud-init configuration ISO attached, but since it was a temporary
+file, it didn't exist. This prevented a VM from being turned off and
+back on again. This is now fixed: the ISO file is detached after the
+VM has booted the first time.
 
 ## Version 0.2.0, released 2021-03-13
 
diff --git a/README.md b/README.md
index 7c56cec..930910d 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,15 @@ $ vmadm help
 $ vmadm --help
 ~~~
 
+A base image is an image with some operating system already installed.
+It should use [cloud-init][] on first boot to configure hostname and
+SSH keys, or at least not mind that there is an extra ISO disk with
+cloud-init configuration attached to the VM. It should open an SSH
+port when it has booted. Other than that, vmadm doesn't care what it
+is. For Debian, the pre-made OpenStack cloud-image at
+<https://cloud.debian.org/> works well. You need to download the base
+image yourself, vmadm doesn't do that for you.
+
 ## Configuration
 
 The default configuration file is `vmadm/config.yaml` under the XDG