From fd21a1a93bd4f7f3fa1ba1b5d3e9bca59ae5526f Mon Sep 17 00:00:00 2001
From: David Byers <david.byers@liu.se>
Date: Thu, 7 Feb 2019 16:50:24 +0100
Subject: [PATCH] Basic documentation added.

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 6af508a..b7a36dc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
 # alerancid
 
+Quick and dirty hacks to pull configuration and some additional
+information from Omniswitch devices.
+
+* We offer no guarantees that this will work for you.
+
+* Feel free to register issues for this project. We might even do
+  something about them, but unless you also provide a patch, it will
+  probably take some time.
+
+* Feel free to contact us with questions but be patient. We might take
+  a while to respond.
+
+## rancid.types.conf
+
+Configuration that goes in rancid.types.conf to enable these
+scripts. You will probably need to update the paths and may want to
+tweak the names.
+
+## aosrancid
+
+Script we use to pull configs from Omniswitch 6540 switches.
+
+**WARNING**
+
+Be careful running aosrancid against AOS 6 prior to 6.2.7 r05. There
+is an issue that under certain circumstances most readliy triggered by
+frequent ssh connections can cause high CPU on individual switches in
+a stack, resulting in dropped traffic.
+
+## omniswitch8
+
+Script we use to pull configs from Omniswitch 6900 switches.
\ No newline at end of file
-- 
GitLab