Permalink
Browse files

Modified README to conform to contrib standard.

  • Loading branch information...
1 parent 0a11331 commit cf5a82c5a9d3fff80de79a351f4a2e17b7d5cb3e @fogus fogus committed Aug 7, 2012
Showing with 75 additions and 5 deletions.
  1. +75 −5 README.md
View
@@ -1,11 +1,81 @@
-# clojure.core.contracts
+clojure.core.contracts
+========================================
Contracts programming for Clojure.
In progress.
-* tolerances
-* generic var rewrite lib
-*
+Based on [Trammel](http://github.com/fogus/trammel) and [clojure-contracts](http://github.com/dnaumov/clojure-contracts).
-Based on [Trammel](http://github.com/fogus/trammel)
+
+Releases and Dependency Information
+========================================
+
+Latest stable release: 0.0.1
+
+* [All Released Versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22core.cache%22)
+
+* [Development Snapshot Versions](https://oss.sonatype.org/index.html#nexus-search;gav~org.clojure~core.contracts~~~)
+
+[Leiningen](https://github.com/technomancy/leiningen) dependency information:
+
+ [org.clojure/core.contracts "0.0.1"]
+
+[Maven](http://maven.apache.org/) dependency information:
+
+ <dependency>
+ <groupId>org.clojure</groupId>
+ <artifactId>core.contracts</artifactId>
+ <version>0.0.1</version>
+ </dependency>
+
+
+
+Example Usage
+========================================
+
+```clojure
+ (use 'clojure.core.contracts)
+
+ (def secure-doubler
+ (with-constraints
+ (fn [n] (* 2 n))
+ (contract doubler
+ "ensures doubling"
+ [x] [number? => (= (* 2 x) %)]
+ [x y] [(every? number? [x y])
+ =>
+ (= (* 2 (+ x y)) %)])))
+
+ (secure-doubler 10)
+ ;=> 20
+```
+
+Refer to docstrings in the `clojure.core.contracts` namespace.
+
+
+
+Developer Information
+========================================
+
+* [GitHub project](https://github.com/clojure/core.contracts)
+
+* [Bug Tracker](http://dev.clojure.org/jira/browse/CCONTRACTS)
+
+* [Continuous Integration](http://build.clojure.org/job/core.contracts/)
+
+* [Compatibility Test Matrix](http://build.clojure.org/job/core.contracts-test-matrix/)
+
+
+
+Change Log
+====================
+
+* Release 0.0.1 on 2012.06.01
+ * Rolled in `contract`, `with-constraints` and `provide` from Trammel
+
+
+Copyright and License
+========================================
+
+Copyright (c) Rich Hickey, Michael Fogus and contributors, 2012. 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-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound bythe terms of this license. You must not remove this notice, or any other, from this software.

0 comments on commit cf5a82c

Please sign in to comment.