1 files changed, 25 insertions, 0 deletions
diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..02806c4
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,25 @@
+# `soft_assert`
+
+Various macros that return early if a given condition is false.
+Similar to the various `assert` macros in `std`
+
+## Usage
+
+Add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+soft_assert = "0.1"
+```
+
+## License
+
+This project is licensed under either of
+
+* [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+  ([LICENSE-APACHE](LICENSE-APACHE))
+
+* [MIT License](http://opensource.org/licenses/MIT)
+  ([LICENSE-MIT](LICENSE-MIT))
+
+at your option.