summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAsko Nõmm <84135165+askonomm@users.noreply.github.com>2022-04-23 02:43:49 +0300
committerGitHub <noreply@github.com>2022-04-23 02:43:49 +0300
commit70d88384ea788f7b2ad5ebb725762f7d27300504 (patch)
treeb371f12617949daf2b40538ba9a2e4457b657d0f /README.md
parent059bfa7bd9bfdde0c75646bf1dfc20d23da8a02c (diff)
parentdc921cbe1c786995a8670efd9f5556ee9df064f9 (diff)
Merge pull request #17 from askonomm/16-improve-architecture
Improve architecture
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 1c96c82..cce655c 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ At its core, Clarktown is nothing more than a collection of parsers that collect
- `strikethrough`
So whenever you call `clarktown.core/render`, those parsers are applied to the content you give it, and are defined collectively in
-`clarktown.parsers/parsers`. If you want to remove certain parsers feel free to duplicate that vector with whatever combination of
+`clarktown.renderers/parsers`. If you want to remove certain parsers feel free to duplicate that vector with whatever combination of
parsers that works best for you, and pass it as the second parameter to the `clarktown.core/render` function, like so:
```clojure
@@ -45,7 +45,7 @@ parsers that works best for you, and pass it as the second parameter to the `cla
## Create your own parsers
As Clarktown is modular, you can easily create your own custom parsers as well. To see how the parsers are made, I really recommend
-checking any of the existing parsers you can find in the `clarktown.parsers/*` namespaces and how they are used in the `clarktown.parsers/parsers` variable,
+checking any of the existing parsers you can find in the `clarktown.renderers/*` namespaces and how they are used in the `clarktown.renderers/parsers` variable,
but overall the idea is very simple: there are (potential) matchers, and renderers.
However, before we get into matchers and renderers, let me quickly explain how Clarktown does its thing. Clarktown splits the entire Markdown
@@ -112,7 +112,7 @@ vector of maps, each map representing one collection. And so to register you cou
(ns myapp.core
(:require
[clarktown.core :as clarktown]
- [clarktown.parsers :refer [parsers]]))
+ [clarktown.renderers :refer [parsers]]))
(def my-parser
{:matcher heading-block/is?