Standardized README and added LICENSE

See ipfs/community#124

Author: RichardLitt

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 IPFS Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,12 +1,11 @@
-#Astral Boot
+# astralboot
 
-Simon Kirkby 
-[email protected]
-20150304
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 
-This repository has been moved to gb format  https://getgb.io/ , it’s cool.
-
-## Description 
+> a low level boot server that deploys directly out of ipfs
 
 Astralboot is a golang server that provides network services to boot virtual and metal machines from pxe boot.
 The following services are provided
@@ -19,35 +18,46 @@ It can pull its data files out of [ipfs](http://ipfs.io/), which means that they
 
 Local file serving also works with local file system folders ( see INSTRUCTIONS for details )
 
-## Required for development
+## Table of Contents
 
-1. golang dev environment
-2. running ipfs node
-3. a network under your control.
-
-## Warning
+- [Install](#install)
+- [Usage](#usage)
+  - [Required for development](#required-for-development)
+  - [Warning](#warning)
+  - [Setup](#setup)
+- [Running the server](#running-the-server)
+- [Changing the services](#changing-the-services)
+- [TODO](#todo)
+- [Contribute](#contribute)
+- [License](#license)
 
-As this server has a naive dhcp server it can be dangerous to run in an office environment. Running this server can interfere with normal network services. 
+# Install
 
-## Installation
-
-assumes a working golang environment.
+Assumes a working golang environment.
 
 ```sh
-
 git clone github.com/zignig/astralboot
 
 cd astralboot
 
 gb build
-
 ```
 
-also the ipfs service, which is currently  in alpha , is available from http://github.com/ipfs/go-ipfs
+You will also need to have the [go-ipfs implemenation](http://github.com/ipfs/go-ipfs) installed, and a daemon running.
 
-will need to be installed and running 
+# Usage
 
-## Setup 
+## Required for development
+
+1. golang dev environment
+2. running ipfs node
+3. a network under your control.
+
+## Warning
+
+As this server has a naive dhcp server it can be dangerous to run in an office environment. Running this server can interfere with normal network services.
+
+## Setup
 
 Testing so far has been done on a virtual machine with two network interfaces, one on a home network and the other an isolated VM network.
 
@@ -103,7 +113,7 @@ Debian will be fairly quick , coreos will take some time as the .gz file is 165
 
 To precache the files into ipfs, run  ipfs refs -r HashFromConfigFile and it will download everything
 
-# Changing the Services
+# Changing the services
 
 As the server boots it will show an implied config , this shows possible entries to the config file to change.
 
@@ -116,12 +126,16 @@ ipfs get -o=data “hash from the refs.toml file”
 ```
 If the config has IPFS = false the local file system will be used.
 
-# Development
+# TODO
 
-all comments, patches and pull requests welcome
-
-# TODO 
-
-1. Better templating of preseed 
+1. Better templating of preseed
 2. Add more operating systems
 4. More stuff
+
+# Contribute
+
+All comments, patches and pull requests welcome.
+
+# License
+
+MIT