Skip to content
Browse files

Updated readme

  • Loading branch information...
1 parent 18e8a76 commit de6a8132f3d40d386bfde2c627f07a8b173fda2b @jonase committed Jan 15, 2012
Showing with 55 additions and 2 deletions.
  1. +55 −2 README.md
View
57 README.md
@@ -1,6 +1,59 @@
-# eastwood
+# eastwood - a Clojure lint tool
-A Clojure Lint Tool
+Eastwood is a clojure lint tool which uses the
+[analyze](https://github.com/frenchy64/analyze) library to inspect
+namespaces and report anomalies. Currently it works with projects
+running Clojure 1.3.0.
+
+## What's there?
+
+Eastwood warns when it finds
+
+- deprecated java instance methods, static fields, static methods and
+ constructors
+- deprecated clojure vars
+- unused let-locals and function arguments
+- unused private vars
+- reflection
+- naked (:use ...)
+- misplaced docstrings
+
+## How to use?
+
+Add
+
+ [eastwood "0.0.1"]
+
+to your `:dev-dependencies` in `project.clj`.
+
+In the REPL:
+
+ > (use 'eastwood.core)
+ > (lint-ns 'my.namespace)
+
+If you want to exclude some linters
+
+ (lint-ns 'my.namespace
+ :exclude [:reflection :unused-private-vars])
+
+If you want to run one (or a few) linters:
+
+ (lint-ns 'my.namespace :only [:misplaced-docstrings])
+
+Available linters include
+
+ :deprecations
+ :reflection
+ :misplaced-docstrings
+ :unused-locals
+ :unused-private-vars
+ :naked-use
+
+## TODO
+
+- Report line numbers.
+- More linters.
+- Lein plugin (will require Leiningen 2.0).
## License

0 comments on commit de6a813

Please sign in to comment.
Something went wrong with that request. Please try again.