From 07a17b442d7d7a397d076babfaa29fd2620921d7 Mon Sep 17 00:00:00 2001
From: Nat Lasseter <user@4574.co.uk>
Date: Thu, 19 Jan 2017 10:54:32 +0000
Subject: Initial commit

---
 readme.textile | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 readme.textile

(limited to 'readme.textile')

diff --git a/readme.textile b/readme.textile
new file mode 100644
index 0000000..e0c69ea
--- /dev/null
+++ b/readme.textile
@@ -0,0 +1,36 @@
+h1. SSHConfig
+
+This is a gem which allows you to programatically configure your ~/.ssh/config.
+
+It's a bit bad, but it works.
+
+h2. Config file
+
+Your new file to worry about is ~/.ssh/sshconfig.
+
+h2. ssh-update-config
+
+The @ssh-update-config@ command will generate the ~/.ssh/config file for you. The file will be overwritten.
+
+h2. Directives
+
+In the block you pass to a host method, any method becomes an sshconfig directive. It's method_missing_madness!
+
+h2. It's all ruby!
+
+h3. So write ruby!
+
+Methods, loops, variables; you name it.
+
+h3. $hostlist variable
+
+The grand list of hosts is stored in @$hostlist@. It's a @Hosts@ object. You can touch this. The @hosts {}@ method appends to this list. @$hostlist.host{}@ does the same as @hosts{host{}}@.
+
+h2. Building
+
+bc.   gem build sshconfig.gemspec
+  gem install --user-install sshconfig
+
+h2. Example
+
+There's an example file, take a look.
-- 
cgit v1.2.3

