first functional commit

README.md

@@ -1 +1,34 @@
 # Kybus
+
+Kybus is a repository
+
+## Requirements
+
+Docker, or podman with appropriate aliases is required to be installed.
+Docker version `20.10.21` is the version using during testing; however, most version should work.
+
+Python3 is required for certain support functions; version `3.10.8` was used during testing.
+
+Libvirt is used for VM deployment; version `8.9.0` was used during testing.
+
+All versions mentioned above are only what was used during testing, other versions will mostly work.
+
+### Quick Reference
+
+- Docker or podman with appropriate aliases
+- Python3
+- libvirt/virt-manager
+
+## Getting Started
+
+Running `setup.sh` will ensure requisites are installed and download needed VM images.
+The Kybus container image will also be generated during this process
+
+## Writing a Plugin
+
+Initial plugin structure can be generated using `ansible-galaxy role init {plugin name}`.
+Plugin names are suggested to be the relavent CVE record; however, certain plugins exist as helpers and may deviate.
+
+Once the plugin is created
+
+##