1 files changed, 12 insertions(+), 0 deletions(-)

M README.md

@@ 2,6 2,18 @@
 
 Vim plugin for executing Python's optional static type checker [MyPy](http://mypy-lang.org/)
 
+## Example
+
+```py
+def example(n: int) -> str:
+    print(type(n))
+    return 'hello'
+
+example("a")  # << incorrect, we've passed a String and not an Integer 
+```
+
+To trigger the plugin, execute either `:Mypy` or the mapping `<Leader>mp`
+
 ## Install
 
 ### [Pathogen](https://github.com/tpope/vim-pathogen)