1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd1f1ad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# EFI Sync
+
+Automatically install your kernel and initrd into the EFI when your Slackware system is updated.
+
+```
+Usage: ./efi-sync {install|watch}
+
+	- install: install the kernel and initrd into your EFI.
+	- watch: install on updates to your kernel
+
+```
+
+`efi-sync` watches your kernel path for updates.  Once one is detected and the
+package commands have completed, your EFI will be updated.  `mkinitrd` to
+update your initial ram disk if its configuration file is present.
+
+## Installation
+
+Run the following are root to install this command:
+```
+cp efi-sync /usr/local/sbin/efi-sync
+chown root:root /usr/local/sbin/efi-sync
+chmod +x /usr/local/sbin/efi-sync
+```
+
+## Configuration
+
+The command looks for configuration at /etc/efi-sync.conf.
+
+Here is an example with the default values:
+```
+# The kernel path to watch.
+KERNEL=/boot/vmlinuz
+# The path to the EFI kernel.
+EFI_KERNEL=/boot/efi/Slackware/vmlinuz
+```
+
+If you want the initial ram disk updated, ensure /etc/mkinitrd.conf exists and
+'OUTPUT_IMAGE' is set to the initrd.gz path on your EFI.