README doc string

Author: YingboMa

Project.toml

@@ -9,6 +9,7 @@ ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
 Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
 ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 DynamicPolynomials = "7c1d4256-1411-5781-91ec-d7bc3513ac07"
 IfElse = "615f187c-cbe4-4ef1-ba3b-2fcf58d6d173"
 LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800"
@@ -27,6 +28,7 @@ ChainRulesCore = "0.9, 0.10, 1"
 Combinatorics = "1.0"
 ConstructionBase = "1.1"
 DataStructures = "0.18"
+DocStringExtensions = "0.8"
 DynamicPolynomials = "0.3"
 IfElse = "0.1"
 LabelledArrays = "1.5"

src/SymbolicUtils.jl

@@ -1,5 +1,9 @@
+"""
+$(DocStringExtensions.README)
+"""
 module SymbolicUtils
 
+using DocStringExtensions
 export @syms, term, showraw, hasmetadata, getmetadata, setmetadata
 
 # Sym, Term,