add README

pyrocord · Mar 7, 2021 · 95f5a58 · 95f5a58
1 parent 5b2b999
commit 95f5a58
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 /target
+Cargo.lock
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# pyexc
+
+An easy way to define Python exceptions.
+
+```rust
+use pyexc::PythonException;
+
+#[derive(PythonException)]
+pub enum MyExceptions {
+    #[base(module = "errors")]
+    #[format("Hello World!!")]
+    Foo,
+}
+```