diff --git a/README.md b/README.md index 5a12704..075ad86 100644 --- a/README.md +++ b/README.md @@ -1 +1,10 @@ A tool for scrubbing .ipynb files before each git commands applies to them +By downloading this tool and then running: +``` +bash install.sh +``` +The filters should be installed, if you wish to check whether it worked. Please check one of your ipynb files using: +``` +git diff YOUR_NOTEBOOK.ipynb +``` +It should now show that all outputs are empty: `outputs: []` \ No newline at end of file