Merge branch 'master' of https://github.com/itsdfish/ACTRModels.jl

README.md

@@ -1,3 +1,21 @@
 # ACTRModels
 
-[![Coverage Status](https://coveralls.io/repos/github/itsdfish/ACTRModels.jl/badge.svg?branch=master)](https://coveralls.io/github/itsdfish/ACTRModels.jl?branch=master)
+ACTRModels.jl provides basic functionality for ACT-R's declarative memory system. The library can be extended to provide functionaty for other modules.
+
+## Example
+The following example demonstrates how to construct an ACTR object containing declarative memory, retrieve a memory, and compute retrieval time. 
+
+```julia
+using ACTRModels, Random
+
+Random.seed!(87545)
+chunks = [Chunk(;name=:Bob, department=:accounting),
+    Chunk(;name=:Alice, department=:HR)]
+
+memory = Declarative(memory=chunks, mmp=true, δ=1.0, noise=true, s=.2)
+
+actr = ACTR(;declarative=memory)
+
+chunk = retrieve(actr; department=:accounting)
+rt = compute_RT(actr, chunk)
+```