improve docs

diff --git a/README b/README
index c3a88f8f183fdf56bdcc3e7801ce314c44294aaf..157bb783391e522af3eaa7210d911568a1339e5f 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,16 @@
 Multi-boot/distro btrfs provisioning
 
-Some things are specific to my home network. Uses pxe or pxe-kexec (for
-systems like libreboot with no pxe rom, we boot into a live cd or distro
-for bootsraping). Works for bare-metal or vms.
+Some things are specific to my home network. Uses pxe or pxe-kexec (on
+libreboot, I have not addded a pxe rom. I use a minimal debian stable
+subvolume which acts like a pxe rom). I use this for bare metal and vms,
+and two scripts which can run post boot so I use them on vps distributed
+image as well.
 
 Features people may find useful: installs encrypted trisquel belanos,
-arch, debian stable, & debian testing all on the same btrfs filesystem.
-Smartly utilizes multiple disks, with scripts to automatically decrypt
-on reboots. The partititioning and filesystem script is at
+arch (havne't done recently, probably a bit broken), debian stable, &
+debian testing which all share the same btrfs filesystem.  Smartly
+utilizes multiple disks, with scripts to automatically decrypt on
+reboots. The partititioning and filesystem script is at
 fai/config/hooks/partition.DEFAULT. Other debian based distros at least
 as new as ubuntu 14.04 should work fine, and I'm planning to add Fedora
 support. Disks are grouped as ssd or hdd and raided in raid 1 or raid 0
@@ -15,14 +18,17 @@ per configuration. The base partitions are divided into boot, swap, and
 root, (only boot is unencrypted). There are scripts to resize those
 partitions post-provision and while the system is running.
 
-The repo name fai is copied from the debian project of the same name,
-meaning "fully automated installer."
+The repo name fai copied from the project of the same name because it
+uses it for debian based installs. People who are familiar with fai may
+find these things usefull: it uses dnsmasq (on a openwrt machine) for
+dhcp instead of the isc dhcp server. fai-wrapper is a small script to
+use basic fai classes outside of fai.
 
 It also fully automates configuration of an openwrt router after manual
 initial installation.
 
-After provisionining is done, I sync files using unison, then automate
-further setup using a different set of scripts,
+After provisionining is done, I sync files using btrfs, or unison for
+vps, then automate further setup using a different set of scripts,
 https://iankelling.org/git/?p=distro-setup;a=tree.
 
 My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops.
@@ -44,6 +50,7 @@ dsfull # install & setup a new fai distro (if data partition already synced)
 eboot # reboot without automatic disk decryption
 fai-kexec # kexec to fai tftp server that pxe would normally point to
 fai-revm  # test fai on a fresh vm
+fai-wrapper # Evaluate and use fai classes outside of fai.
 faiserver-revm # create a vm which is a fai server using pxe & preseed file
 faiserver-uninstall # uninstall fai-server
 faiserver-setup # install fai-server on the current machine