From acde0aeac2d871f0e7bdba1b911e88a9e7ca59f4 Mon Sep 17 00:00:00 2001 From: Daniel Compton Date: Mon, 1 Apr 2019 06:38:23 +1300 Subject: [PATCH] Add badge and more motivation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c19cbb2..5d50083 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # defn-spec -[![CircleCI](https://circleci.com/gh/danielcompton/defn-spec.svg?style=svg)](https://circleci.com/gh/danielcompton/defn-spec) +[![CircleCI](https://circleci.com/gh/danielcompton/defn-spec.svg?style=svg)](https://circleci.com/gh/danielcompton/defn-spec) [![Clojars Project](https://img.shields.io/clojars/v/net.danielcompton/defn-spec-alpha.svg)](https://clojars.org/net.danielcompton/defn-spec-alpha) defn-spec lets you create Clojure Specs inline with your `defn`. The syntax (and implementation) has been borrowed from [Schema](https://github.com/plumatic/schema), so if you've used that before, this should be very familiar. @@ -82,6 +82,8 @@ I've been using Clojure spec for a while, but I found that I often resisted writ I created defn-spec to increase the locality of the spec definitions, and to reduce the activation energy to start adding specs to your codebase. I wanted to make something that was small enough to drop into any project or library I worked on. +defn-spec doesn't introduce any concepts or features to spec. The only deviation from vanilla spec is that defn-spec will automatically build the `s/cat` form for you from the arguments that you provide. + ## Alternatives * Orchestra has a [defn-spec](https://github.com/jeaye/orchestra#defn-spec) macro. Cursive doesn't yet have support for this macro though, and it requires you to provide specs for every function argument. Orchestra is great though, and I recommend everyone check it out, especially for instrumenting their `:ret` and `:fn` specs.