document package via README.md

ranocha · ranocha · commit d91c1aa7d583 · 2019-09-15T20:04:51.000+03:00
diff --git a/src/RootedTrees.jl b/src/RootedTrees.jl
@@ -1,5 +1,7 @@
 module RootedTrees
 
+@doc read(joinpath(dirname(@__DIR__), "README.md"), String) RootedTrees
+
 
 using LinearAlgebra
 
@@ -455,7 +457,7 @@ end
 
 
 """
-  butcher_represetation(t::RootedTree)
+    butcher_represetation(t::RootedTree)
 
 Returns the representation of `t::RootedTree` as introduced by Butcher.
 
