From c6e5431d47139c70983623d25ed4347076747159 Mon Sep 17 00:00:00 2001
From: Joshua Boniface <joshua@boniface.me>
Date: Fri, 31 Mar 2017 02:08:35 -0400
Subject: [PATCH] Updated README to match refactoring

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ffbc13e..6797f04 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
 # rpibmc
-A BMC (LOM) created with a Raspberry Pi
+A BMC (LOM) created with a Raspberry Pi.
+
+Allows one to build a Raspberry Pi-based BMC unit for an IPMI-less server.
+
+There are three main files:
+1) `bmcd` - BMC Daemon
+   Runs in the background of the system and handles reading and writing GPIO.
+2) `bmc.sh` - The BMC shell
+   Should be set as the default shell of the login user (`bmc`) and provides
+   user interface to the BMC.
+3) `rc.local` - The rc.local file
+   The system `rc.local` should be replaced (or symlinked) to this file to start
+   the `bmcd` daemon and `screen` console session on boot.
+   
\ No newline at end of file