summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 8 insertions, 18 deletions
diff --git a/README.md b/README.md
index a0d6016..4a299bd 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,12 @@
-# clarktown
+# Clarktown
-A Clojure library designed to ... well, that part is up to you.
+A zero-dependency Markdown parser for Clojure projects.
-## Usage
+## Usage example
-FIXME
+```clojure
+(ns myapp.core
+ (:require [clarktown.core :as clarktown]))
-## License
-
-Copyright © 2021 FIXME
-
-This program and the accompanying materials are made available under the
-terms of the Eclipse Public License 2.0 which is available at
-http://www.eclipse.org/legal/epl-2.0.
-
-This Source Code may also be made available under the following Secondary
-Licenses when the conditions for such availability set forth in the Eclipse
-Public License, v. 2.0 are satisfied: GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or (at your
-option) any later version, with the GNU Classpath Exception which is available
-at https://www.gnu.org/software/classpath/license.html.
+(clarktown/render "**Hello, world!**")
+``` \ No newline at end of file