aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bddcf1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# `mdpoly` Multidimensional Polynomials
+
+Work in progress!
+
+## Minimal working example
+
+```python
+import mdpoly as poly
+
+x, y = poly.Variable.from_names("x, y")
+
+p = x + 2 * y + y ** 2
+```