Add README

kgryte · kgryte · commit cb92d9be2221 · 2017-07-20T09:56:16.000-07:00
diff --git a/tools/lint/julia/README.md b/tools/lint/julia/README.md
@@ -0,0 +1,56 @@
+# Lint
+
+> Lint [Julia][julia] source files.
+
+<section class="cli">
+
+## CLI
+
+<section class="usage">
+
+### Usage
+
+``` bash
+Usage: <linter.jl> <file> <file> <file> ...
+```
+
+</section>
+
+<!-- /.usage -->
+
+
+<section class="notes">
+
+### Notes
+
+* Each provided filepath is resolved relative to the current working directory of the calling process.
+
+</section>
+
+<!-- /.notes -->
+
+
+<section class="examples">
+
+### Examples
+
+``` bash
+$ <linter.jl> ./linter.jl
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.cli -->
+
+
+<section class="links">
+
+[julia]: https://julialang.org/
+
+</section>
+
+<!-- /.links -->
