Update readme and add release notes

Signed-off-by: Brent Baude <[email protected]>
containers · Mar 17, 2023 · 33efeaf · 33efeaf
1 parent 3fddf9a
commit 33efeaf
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,17 @@
 # libhvee
-Special purposed library for Windows HyperV control
+
+Libhvee is a special purposed library for interacting with Microsoft's HyperV hypervisor.  It was designed with the 
+[Ignition](https://coreos.github.io/ignition/) and [Podman](https://github.com/containers/podman) projects in mind
+largely because Podman Machine would like to support HyperV in addition to WSL2.
+
+The libhvee library can do the following with HyperV virtual machines:
+
+* Create
+* Start
+* Stop
+* Remove
+* Obtain various statuses
+* Add and read key-value pairs used for passing information from the host to guest virtual machines.
+
+For an example on how to use this library, consider consulting the examples
+in the [cmd dir](https://github.com/containers/libhvee/tree/main/cmd).
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -0,0 +1,5 @@
+
+# Release Notes
+
+## v0.0.1
+* Development release