README and TODO docs cleanup (#6)

Signed-off-by: Noah Meyerhans <[email protected]>

Author: nmeyerhans

README.md

@@ -5,8 +5,9 @@ This package is a Go library to interact with the Firecracker API.  There is
 also a command-line application that can be used to control Firecracker microVMs
 called `firectl`.
 
-The library and command-line application are not yet complete. See the
-[TODO](TODO.md) file for an incomplete list of missing features.
+There are some Firecracker features that are not yet supported by the
+SDK. Please see the [TODO](TODO.md) file for details. Contributions to
+address missing features are welcomed.
 
 Developing
 ---
@@ -30,16 +31,16 @@ access to filesystems, and network connectivity.
 
 ```
 Usage of ./cmd/firectl/firectl:
-    --firecracker-binary=  Path to firecracker binary
+    --firecracker-binary=  Path to Firecracker binary
     --firecracker-console= Console type (stdio|xterm|none) (default: stdio)
     --kernel=              Path to the kernel image (default: ./vmlinux)
     --kernel-opts=         Kernel commandline (default: ro console=ttyS0 noapic reboot=k panic=1 pci=off nomodules)
     --root-drive=          Path to root disk image
     --add-drive=           Path to additional drive, suffixed with :ro or :rw, can be specified multiple times
     --tap-device=          NIC info, specified as DEVICE:MAC
-    --vmm-log-fifo=        FIFO for firecracker logs
+    --vmm-log-fifo=        FIFO for Firecracker logs
     --log-level=           vmm log level (default: Debug)
-    --metrics-fifo=        FIFO for firecracker metrics
+    --metrics-fifo=        FIFO for Firecracker metrics
 -d, --debug                Enable debug output
 -h, --help                 Show usage
 ```
@@ -49,7 +50,9 @@ Usage of ./cmd/firectl/firectl:
 Network configuration
 ---
 
-TODO
+Firecracker, by design, only supports Linux tap devices. The SDK
+provides facilities to attach a tap device to the Firecracker VM, but
+the client is responsible for further configuration.
 
 License
 ====

TODO.md

@@ -6,8 +6,10 @@ Features
 
 There's currently no support for specifying rate limits for network or block device access.
 
-Better integration with CNI could be nice. Currently, the network namespace should be created ahead of time by and, and the CNI plugins should be run within it to configure the network. Then the firecracker process (`cmd/firectl/firectl` or whatever process is calling the library) can join that namespace and attach to the appropriate TAP device. At least some of this workflow should be integrated into the library.
+Support for configuring the Firecracker MMDS.
 
-Integration with the `jailer`
+Integration with the [jailer](https://github.com/firecracker-microvm/firecracker/blob/master/docs/jailer.md)
 
+Tests
+---
 The tests rely on a bunch of hardcoded information and priviledged access. This should be fixed.