diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d6dc2f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+pre-commit hook to remove cell output of .ipynb notebook and some metadata for better security.
+
+Sample config:
+```
+repos:
+  - repo: https://github.com/aflc/pre-commit-jupyter
+    rev: v1.0.0
+    hooks:
+      - id: jupyter-notebook-cleanup
+        args:
+          - --remove-kernel-metadata
+          - --pin-patterns
+          - "[pin];[donotremove]"
+```
+
+If you have "pin patterns", You can keep cell outputs like that:
+
+```
+# [pin]
+some_function()
+print("some info")
+```
+
+```
+# [donotremove]
+some_function()
+print("some info")
+```