Permalink
Browse files

update README based on guidelines from http://dev.clojure.org/display…

  • Loading branch information...
1 parent 35234f7 commit 74bfc292f1201ce47f3294aa51df402fb148d203 @cosmin cosmin committed Aug 9, 2012
Showing with 58 additions and 18 deletions.
  1. +58 −18 README.md
View
@@ -1,41 +1,81 @@
# java.data
-Future home of Java beans and properties support from contrib. Currently contains functions for recursively converting Java beans to Clojure and vice versa.
+Functions for recursively converting Java beans to Clojure and vice
+versa. Future home of Java beans and properties support from the old
+clojure-contrib
-## Example
+## Releases and Dependency Information
+Latest stable release: 0.1.1
+
+* [All Released Versions](http://search.maven.org/#search%7Cga%7C1%7Corg.clojure%20java.data)
+* [Development Snapshot Versions](https://repository.sonatype.org/index.html#nexus-search;gav~org.clojure~java.data~~~)
+
+### Leiningen
+
+```
+[org.clojure/java.data "0.1.1"]
+```
+
+### Maven
+
+```
+<dependency>
+ <groupId>org.clojure</groupId>
+ <artifactId>java.data</artifactId>
+ <version>0.1.1</version>
+</dependency>
+```
+
+## Example Usage
+
+```
(use 'clojure.java.data)
(to-java YourJavaClass clojure-property-map)
(from-java javaValue)
+```
-## Extending
-
-;; Representing an instance of YourJavaClass in a Clojure data structure
+Representing an instance of YourJavaClass in a Clojure data structure
+```
(defmethod from-java YourJavaClass [instance]
-
; your custom logic for turing this instance into a clojure data structure
-
)
+```
-;; Constructing an instance of YourJavaClass from a Clojure data structure
+Constructing an instance of YourJavaClass from a Clojure data structure
+```
(defmethod to-java [YourJavaClass clojure.lang.APersistentMap] [clazz props]
-
; your custom logic for constructing an instance from a property map
-
)
+```
-## License
+## Developer Information
-Copyright (c) Rich Hickey and contributors. All rights reserved.
+* [GitHub project](https://github.com/clojure/java.data)
-The use and distribution terms for this software are covered by the
-Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
-which can be found in the file epl.html at the root of this distribution.
-By using this software in any fashion, you are agreeing to be bound by
-the terms of this license.
-You must not remove this notice, or any other, from this software.
+* [Bug Tracker](http://dev.clojure.org/jira/browse/JDATA)
+
+* [Continuous Integration](http://build.clojure.org/job/java.data/)
+
+* [Compatibility Test Matrix](http://build.clojure.org/job/java.data-test-matrix/)
+## Change Log
+* Release 0.1.1 on 2012-04-29
+ * Initial release.
+ * Clojure 1.2 compatiblity
+
+## Copyright and License
+
+Copyright (c) Rich Hickey and contributors. All rights reserved.
+
+The use and distribution terms for this software are covered by the
+[Eclipse Public License
+1.0](http://opensource.org/licenses/eclipse-1.0.php) which can be
+found in the file epl.html at the root of this distribution. By using
+this software in any fashion, you are agreeing to be bound by the
+terms of this license. You must not remove this notice, or any other,
+from this software.

0 comments on commit 74bfc29

Please sign in to comment.