Add README

README.md

@@ -1,7 +1,35 @@
-# RecursiveArrayTools
+# RecursiveArrayTools.jl
 
 [![Build Status](https://travis-ci.org/ChrisRackauckas/RecursiveArrayTools.jl.svg?branch=master)](https://travis-ci.org/ChrisRackauckas/RecursiveArrayTools.jl)
-
+[![Build status](https://ci.appveyor.com/api/projects/status/esjxtbl5lv9vun1j?svg=true)](https://ci.appveyor.com/project/ChrisRackauckas/recursivearraytools-jl)
 [![Coverage Status](https://coveralls.io/repos/ChrisRackauckas/RecursiveArrayTools.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/ChrisRackauckas/RecursiveArrayTools.jl?branch=master)
-
 [![codecov.io](http://codecov.io/github/ChrisRackauckas/RecursiveArrayTools.jl/coverage.svg?branch=master)](http://codecov.io/github/ChrisRackauckas/RecursiveArrayTools.jl?branch=master)
+
+RecursiveArrayTools.jl is a set of tools for dealing with recursive arrays like
+arrays of arrays. The current functionality includes:
+
+```julia
+recursivecopy!(b::Array{T,N},a::Array{T,N})
+```
+
+A recursive `copy!` function. Acts like a `deepcopy!` on arrays of arrays, but
+like `copy!` on arrays of scalars.
+
+```julia
+vecvec_to_mat(vecvec)
+```
+
+Takes in a vector of vectors, returns a matrix.
+
+```julia
+vecvecapply(f::Base.Callable,v)
+```
+
+Calls `f` on each element of a vecvec `v`.
+
+```julia
+copyat_or_push!{T}(a::AbstractVector{T},i::Int,x)
+```
+
+If `i<length(x)`, it's simply a `recursivecopy!` to the `i`th element. Otherwise it will
+`push!` a `deepcopy`.