📚 DOCS: Add usage description for pytest CLI in README (chrisjsewell#22)

Author: j3soon

README.md

@@ -72,6 +72,23 @@ To install the development version:
 
 See the documentation at: http://pytest-notebook.readthedocs.io/
 
+If you want to test some sample notebooks, add the `--nb-test-files` flag:
+
+```shell
+>> git clone https://github.com/chrisjsewell/pytest-notebook
+>> cd pytest-notebook/samples
+>> pip install pytest ipykernel pytest-notebook
+>> pytest --nb-test-files *.ipynb
+```
+
+You should see `success.ipynb` passed the test and `fail.ipynb` failed the test.
+
+You can regenerate the outputs of `fail.ipynb` with the `--nb-force-regen` flag:
+
+```shell
+>> pytest --nb-test-files --nb-force-regen *.ipynb
+```
+
 ## Contributing
 
 Contributions are very welcome.

examples/fail.ipynb

@@ -0,0 +1,37 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "B\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(\"A\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

examples/pytest.ini

@@ -0,0 +1,37 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "A\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(\"A\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}