writing README

wookay · Jun 23, 2018 · cdaf17e · cdaf17e
1 parent 88960d6
commit cdaf17e
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -1,56 +1,33 @@
 # 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]  |
 
 
-# Install
-```julia
-λ ~$ julia
-               _
-   _       _ _(_)_     |  A fresh approach to technical computing
-  (_)     | (_) (_)    |  Documentation: https://docs.julialang.org
-   _ _   _| |_  __ _   |  Type "?help" for help.
-  | | | | | | |/ _` |  |
-  | | |_| | | | (_| |  |  Version 0.6.0 (2017-06-19 13:05 UTC)
- _/ |\__'_|_|_|\__'_|  |  Official http://julialang.org/ release
-|__/                   |  x86_64-apple-darwin13.4.0
+Get julia data in a tablized format to arrange into rows and columns of cells.
 
-julia> Pkg.add("Millboard")
-INFO: Installing Millboard v0.1.0
 
-julia> Pkg.checkout("Millboard", "master")
-```
+# Example
 
-
-# Example - numbers
 ```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 into the Markdown format.
+
+```julia
 julia> table(board)
 |   |  1 |  2 |  3 |
 |---|----|----|----|
 | 1 | 11 | 12 | 13 |
 | 2 | 21 | 22 | 23 |
 
-julia> table(board, colnames=["x" "y" "z"])
-|   |  x |  y |  z |
-|---|----|----|----|
-| 1 | 11 | 12 | 13 |
-| 2 | 21 | 22 | 23 |
-
-julia> table(board, rownames=["A" "B"])
-|   |  1 |  2 |  3 |
-|---|----|----|----|
-| A | 11 | 12 | 13 |
-| B | 21 | 22 | 23 |
-
 julia> table(board, colnames=["x" "y" "z"], rownames=["A" "B"])
 |   |  x |  y |  z |
 |---|----|----|----|
@@ -59,7 +36,7 @@ julia> table(board, colnames=["x" "y" "z"], rownames=["A" "B"])
 ```
 
 
-* `Millboard.set_table_mode` : to change display mode
+* `Millboard.set_table_mode` : to change the display mode
   - `:markdown` (default)
   - `:grid`
 
@@ -127,3 +104,37 @@ julia> table(board)
 | 3x1 |     3 |
 +-----+-------+
 ```
+
+
+# Install
+
+```julia
+λ ~$ julia
+               _
+   _       _ _(_)_     |  A fresh approach to technical computing
+  (_)     | (_) (_)    |  Documentation: https://docs.julialang.org
+   _ _   _| |_  __ _   |  Type "?help" for help.
+  | | | | | | |/ _` |  |
+  | | |_| | | | (_| |  |  Version 0.6.0 (2017-06-19 13:05 UTC)
+ _/ |\__'_|_|_|\__'_|  |  Official http://julialang.org/ release
+|__/                   |  x86_64-apple-darwin13.4.0
+
+julia> Pkg.add("Millboard")
+
+julia> Pkg.checkout("Millboard", "master")
+```
+
+
+[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
+[docs-latest-url]: https://wookay.github.io/docs/Millboard.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
+
+
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,51 +1,29 @@
 # Millboard
 
-# Install
-```julia
-λ ~$ julia
-               _
-   _       _ _(_)_     |  A fresh approach to technical computing
-  (_)     | (_) (_)    |  Documentation: https://docs.julialang.org
-   _ _   _| |_  __ _   |  Type "?help" for help.
-  | | | | | | |/ _` |  |
-  | | |_| | | | (_| |  |  Version 0.6.0 (2017-06-19 13:05 UTC)
- _/ |\__'_|_|_|\__'_|  |  Official http://julialang.org/ release
-|__/                   |  x86_64-apple-darwin13.4.0
 
-julia> Pkg.add("Millboard")
-INFO: Installing Millboard v0.1.0
+Get julia data in a tablized format to arrange into rows and columns of cells.
 
-julia> Pkg.checkout("Millboard", "master")
-```
 
+# Example
 
-# Example - numbers
 ```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 into the Markdown format.
+
+```julia
 julia> table(board)
 |   |  1 |  2 |  3 |
 |---|----|----|----|
 | 1 | 11 | 12 | 13 |
 | 2 | 21 | 22 | 23 |
 
-julia> table(board, colnames=["x" "y" "z"])
-|   |  x |  y |  z |
-|---|----|----|----|
-| 1 | 11 | 12 | 13 |
-| 2 | 21 | 22 | 23 |
-
-julia> table(board, rownames=["A" "B"])
-|   |  1 |  2 |  3 |
-|---|----|----|----|
-| A | 11 | 12 | 13 |
-| B | 21 | 22 | 23 |
-
 julia> table(board, colnames=["x" "y" "z"], rownames=["A" "B"])
 |   |  x |  y |  z |
 |---|----|----|----|
@@ -54,7 +32,7 @@ julia> table(board, colnames=["x" "y" "z"], rownames=["A" "B"])
 ```
 
 
-* `Millboard.set_table_mode` : to change display mode
+* `Millboard.set_table_mode` : to change the display mode
   - `:markdown` (default)
   - `:grid`
 
@@ -122,3 +100,22 @@ julia> table(board)
 | 3x1 |     3 |
 +-----+-------+
 ```
+
+
+# Install
+
+```julia
+λ ~$ julia
+               _
+   _       _ _(_)_     |  A fresh approach to technical computing
+  (_)     | (_) (_)    |  Documentation: https://docs.julialang.org
+   _ _   _| |_  __ _   |  Type "?help" for help.
+  | | | | | | |/ _` |  |
+  | | |_| | | | (_| |  |  Version 0.6.0 (2017-06-19 13:05 UTC)
+ _/ |\__'_|_|_|\__'_|  |  Official http://julialang.org/ release
+|__/                   |  x86_64-apple-darwin13.4.0
+
+julia> Pkg.add("Millboard")
+
+julia> Pkg.checkout("Millboard", "master")
+```