writing README

README.md

@@ -1,11 +1,15 @@
 # Millboard
 
-Linux, OSX: [![Build Status](https://api.travis-ci.org/wookay/Millboard.jl.svg?branch=master)](https://travis-ci.org/wookay/Millboard.jl)
-Windows: [![Build status](https://ci.appveyor.com/api/projects/status/3hjdk20juucb3kiw?svg=true)](https://ci.appveyor.com/project/wookay/Millboard.jl)
-[![Coverage Status](https://coveralls.io/repos/wookay/Millboard.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/wookay/Millboard.jl?branch=master)
+|  **Documentation**                        |  **Build Status**                                                                                   |
+|:-----------------------------------------:|:---------------------------------------------------------------------------------------------------:|
+|  [![][docs-latest-img]][docs-latest-url]  |  [![][travis-img]][travis-url] [![][appveyor-img]][appveyor-url] [![][coverage-img]][coverage-url]  |
+
+
+Get data in a tablized format to arrange into rows and columns of cells.
 
 
 # Install
+
 ```julia
 λ ~$ julia
                _
@@ -18,21 +22,25 @@ Windows: [![Build status](https://ci.appveyor.com/api/projects/status/3hjdk20juu
 |__/                   |  x86_64-apple-darwin13.4.0
 
 julia> Pkg.add("Millboard")
-INFO: Installing Millboard v0.1.0
 
 julia> Pkg.checkout("Millboard", "master")
 ```
 
 
-# Example - numbers
+# Example
+
 ```julia
 julia> using Millboard
 
 julia> board = [11 12 13; 21 22 23]
 2×3 Array{Int64,2}:
  11  12  13
  21  22  23
+```
+
+* `table(x)` displays the data to the Markdown format.
 
+```julia
 julia> table(board)
 |   |  1 |  2 |  3 |
 |---|----|----|----|
@@ -127,3 +135,16 @@ julia> table(board)
 | 3x1 |     3 |
 +-----+-------+
 ```
+
+
+[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
+[docs-latest-url]: https://wookay.github.io/docs/Octo.jl/
+
+[travis-img]: https://api.travis-ci.org/wookay/Millboard.jl.svg?branch=master
+[travis-url]: https://travis-ci.org/wookay/Millboard.jl
+
+[appveyor-img]: https://ci.appveyor.com/api/projects/status/3hjdk20juucb3kiw?svg=true
+[appveyor-url]: https://ci.appveyor.com/project/wookay/Millboard.jl
+
+[coverage-img]: https://coveralls.io/repos/wookay/Millboard.jl/badge.svg?branch=master&service=github
+[coverage-url]: https://coveralls.io/github/wookay/Millboard.jl?branch=master

docs/src/index.md

@@ -1,6 +1,11 @@
 # Millboard
 
+
+Get data in a tablized format to arrange into rows and columns of cells.
+
+
 # Install
+
 ```julia
 λ ~$ julia
                _
@@ -13,21 +18,25 @@
 |__/                   |  x86_64-apple-darwin13.4.0
 
 julia> Pkg.add("Millboard")
-INFO: Installing Millboard v0.1.0
 
 julia> Pkg.checkout("Millboard", "master")
 ```
 
 
-# Example - numbers
+# Example
+
 ```julia
 julia> using Millboard
 
 julia> board = [11 12 13; 21 22 23]
 2×3 Array{Int64,2}:
  11  12  13
  21  22  23
+```
 
+* `table(x)` displays the data to the Markdown format.
+
+```julia
 julia> table(board)
 |   |  1 |  2 |  3 |
 |---|----|----|----|