Permalink
Browse files

readme

  • Loading branch information...
1 parent 6cea144 commit c53741126db3b67056273b29db4ee387ae4adee7 @frenchy64 frenchy64 committed Mar 7, 2014
Showing with 16 additions and 1 deletion.
  1. +16 −1 README.md
View
@@ -8,6 +8,8 @@ Run `lein typed check`.
## Installation
+A core.typed [dependency](https://github.com/clojure/core.typed) must be specified.
+
Use this for user-level plugins:
Put `[lein-typed "0.3.3"]` into the `:plugins` vector of your
@@ -18,7 +20,7 @@ Use this for project-level plugins:
Put `[lein-typed "0.3.3"]` into the `:plugins` vector of your project.clj.
-## Checking
+## Clojure Checking
To type check many namespaces, add namespaces to your project.clj like
@@ -42,6 +44,19 @@ To type check speific namespaces, provide one or more namespace symbols to `chec
Checked typed-demo.core in 94.891391 msecs
Checked 1 namespaces (approx. 7 lines) in 6138.087383 msecs
+## ClojureScript Checking
+
+To type check many ClojureScript namespaces, add namespaces to your project.clj like
+
+ :core.typed {:check-cljs [my.ns1 my.ns2]}
+
+Then run
+
+ $ lein typed check-cljs
+ ...
+
+Requires core.typed 0.2.36 or later.
+
## Type coverage
`lein typed coverage` is used the same as `check`, except information on type annotation coverage

0 comments on commit c537411

Please sign in to comment.