summaryrefslogtreecommitdiffstats
path: root/benchmark/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'benchmark/README.md')
-rw-r--r--benchmark/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/benchmark/README.md b/benchmark/README.md
new file mode 100644
index 0000000..5a35172
--- /dev/null
+++ b/benchmark/README.md
@@ -0,0 +1,22 @@
+# Benchmark
+
+## Acknowledgments
+
+This benchmark was shamelessly copied from
+[pytomlpp](https://github.com/bobfang1992/pytomlpp/tree/e6b03726f8347c6a6757f520ad1b5fab68ed8534/benchmark)
+repository and edited.
+Credit goes to the authors of that project.
+
+## Running
+
+### Against the local Tomli state
+
+```bash
+tox -e benchmark
+```
+
+### Against the latest Tomli PyPI release
+
+```bash
+tox -e benchmark-pypi
+```