diff --git a/README.md b/README.md index 7274939..da7db18 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,25 @@ or nbstripout -t FILE.ipynb | other-command +Do a dry run and only list which files would have been stripped: + + nbstripout --dry-run FILE.ipynb [FILE2.ipynb ...] + +Operate on all `.ipynb` files in the current directory and subdirectories +recursively: + + find . -name '*.ipynb' -exec nbstripout {} + + +Print the version: + + nbstripout --version + +Show help and usage instructions: + + nbstripout --help + +### Using as a Git filter + Set up the git filter and attributes as described in the manual installation instructions below: @@ -132,18 +151,6 @@ if installed, 1 otherwise): nbstripout --status -Do a dry run and only list which files would have been stripped: - - nbstripout --dry-run FILE.ipynb [FILE2.ipynb ...] - -Print the version: - - nbstripout --version - -Show help and usage instructions: - - nbstripout --help - ### Configuration files The following table shows in which files the `nbstripout` filter and attribute