docs: add usage to README

KnisterPeter · May 30, 2017 · 86858b3 · 86858b3
1 parent d2f92e0
commit 86858b3
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,17 @@
 tscodeshift is a toolkit for running codemods over multiple TS files.
 It borrows its ideas from [jscodeshift](https://github.com/facebook/jscodeshift) in a shameless manner.
 
+## Usage
+
+```
+  Usage: tscodeshift <path>... [options]
+
+  path     Files or directory to transform
+
+  Options:
+    -t FILE, --transform FILE   Path to the transform file. Can be either a local path or url  [./transform.js]
+```
+
 
 [license-image]: https://img.shields.io/github/license/KnisterPeter/tscodeshift.svg
 [license-link]: https://github.com/KnisterPeter/tscodeshift