Permalink
Browse files

bump version plus docu

  • Loading branch information...
mihi-tr committed Jun 27, 2015
1 parent 1bd866c commit 28534d7845d66e93488c022e703068d9e1dc3729
Showing with 27 additions and 3 deletions.
  1. +26 −2 README.md
  2. +1 −1 project.clj
View
@@ -1,15 +1,39 @@
# archieclj
-A Clojure parser for [archieml](http://archieml.org)
+A Clojure parser for [archieml](http://archieml.org).
+
+Archieml is a markup language designed to be written by humans for
+computers. It is very forgiving and highly welcoming. Developed at the New
+York Times its main audience are Journalists who do require to write
+structured data but do not want to bother with JSON or yaml.
+
+This is a Clojure parser for Archieml.
## Usage
In leinigen add
```clojure
-[archieclj 0.0.1-SNAPSHOT]
+[archieclj 0.1.0]
+```
+
+Then use
+
+```clojure
+(require '[archieclj.core :as archieclj])
+
+archieclj/parse("key: value")
```
+## Contribute
+
+Contributions are highly welcome! You can contribute by
+
+* Using the library and providing feedback in github issues
+* Writing better Documentation
+* Fixing bugs and Issues
+* Discussing Issues and solving them (some might not need code)
+
## License
Copyright © 2015 FIXME
View
@@ -1,4 +1,4 @@
-(defproject archieclj "0.1.0-SNAPSHOT"
+(defproject archieclj "0.1.0"
:description "An archieml parser for clojure"
:url "https://github.com/mihi-tr/archieclj"
:license {:name "Eclipse Public License"

0 comments on commit 28534d7

Please sign in to comment.