From 1bb9a44ac4c75fb31dd7f71a56bd92be1b64cdf3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Greg=20Kar=C3=A9kinian?= <greg@karekinian.com>
Date: Fri, 8 Jul 2016 16:04:12 +0200
Subject: [PATCH] Add README to sockethub cookbook

---
 site-cookbooks/sockethub/README.md | 61 +++++++-----------------------
 1 file changed, 13 insertions(+), 48 deletions(-)

diff --git a/site-cookbooks/sockethub/README.md b/site-cookbooks/sockethub/README.md
index f171323..5158dcd 100644
--- a/site-cookbooks/sockethub/README.md
+++ b/site-cookbooks/sockethub/README.md
@@ -1,23 +1,11 @@
 sockethub Cookbook
 ==================
-TODO: Enter the cookbook description here.
 
-e.g.
-This cookbook makes your favorite breakfast sandwich.
-
-Requirements
-------------
-TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc.
-
-e.g.
-#### packages
-- `toaster` - sockethub needs toaster to brown your bagel.
+This cookbook installs [sockethub](https://github.com/sockethub/sockethub)
 
 Attributes
 ----------
-TODO: List your cookbook attributes here.
 
-e.g.
 #### sockethub::default
 <table>
   <tr>
@@ -27,42 +15,19 @@ e.g.
     <th>Default</th>
   </tr>
   <tr>
-    <td><tt>['sockethub']['bacon']</tt></td>
-    <td>Boolean</td>
-    <td>whether to include bacon</td>
-    <td><tt>true</tt></td>
+    <td><tt>['sockethub']['port']</tt></td>
+    <td>Integer</td>
+    <td>The local port to run sockethub on</td>
+    <td><tt>10551</tt></td>
+  </tr>
+  <tr>
+    <td><tt>['sockethub']['external_port']</tt></td>
+    <td>Integer</td>
+    <td>The external port to run sockethub on. This will also open the port on the firewall</td>
+    <td><tt>10550</tt></td>
   </tr>
 </table>
 
-Usage
------
-#### sockethub::default
-TODO: Write usage instructions for each cookbook.
+Right now the nginx vhost is hardcoded: sockethub.kosmos.org
 
-e.g.
-Just include `sockethub` in your node's `run_list`:
-
-```json
-{
-  "name":"my_node",
-  "run_list": [
-    "recipe[sockethub]"
-  ]
-}
-```
-
-Contributing
-------------
-TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.
-
-e.g.
-1. Fork the repository on Github
-2. Create a named feature branch (like `add_component_x`)
-3. Write your change
-4. Write tests for your change (if applicable)
-5. Run the tests, ensuring they all pass
-6. Submit a Pull Request using Github
-
-License and Authors
--------------------
-Authors: TODO: List authors
+Sockethub will be available under https://sockethub.kosmos.org:10550