Permalink
Browse files

Release 1.0.0.

  • Loading branch information...
1 parent ef5fab1 commit e0edca66abe458f0fb95ff08b182c98d2d91255f @technomancy technomancy committed Apr 26, 2011
Showing with 37 additions and 2 deletions.
  1. +36 −1 README.md
  2. +1 −1 project.clj
View
@@ -25,10 +25,45 @@
Slamhound rips your ns form apart and reconstructs it. No Dutch
surgeon required.
-## Usage
+## Leiningen Usage
+
+For this you will need to add Slamhound in both :dependencies and
+:dev-dependencies:
+
+ [slamhound "1.0.0"]
+
+Then run from the command line:
$ lein slamhound my.namespace
+ (ns my.namespace
+ "I have a doc string."
+ (:use [clojure.pprint :only [pprint]])
+ (:require [clojure.java.io :as io])
+ (:import (java.io ByteArrayInputStream)))
+
+## Emacs Usage
+
+For this, it only needs to be in :dependencies. Once it's in, start a
+Slime session. Then add this defun to your Emacs config:
+
+ (defun slamhound ()
+ (interactive)
+ (goto-char (point-min))
+ (kill-sexp)
+ (insert (first (slime-eval `(swank:eval-and-grab-output
+ (format "(do (require 'slam.hound)
+ (slam.hound/reconstruct \"%s\"))"
+ ,buffer-file-name))))))
+
+Then you'll be able to run M-x slamhound to reconstruct your ns form.
+
+## Future Plans
+
+* Better pretty-printing
+* Piggy-backing elisp inside jar
+* Allow for custom disambiguator functions
+
## License
Copyright (C) 2011 Phil Hagelberg
View
@@ -1,4 +1,4 @@
-(defproject slamhound "1.0.0-SNAPSHOT"
+(defproject slamhound "1.0.0"
:description
"Rips your ns form apart and reconstructs it. We have the technology."
;; TODO: will eliminate this dep down the road

0 comments on commit e0edca6

Please sign in to comment.