Merge pull request #870 from valentinewallace/invoices-crate

[rust-lightning] / lightning-invoice / README.md

diff --git a/lightning-invoice/README.md b/lightning-invoice/README.md
new file mode 100644 (file)
index 0000000..e9968d2
--- /dev/null
+++ b/lightning-invoice/README.md
@@ -0,0 +1,9 @@
+# lightning-invoice
+ [![Docs.rs](https://docs.rs/lightning-invoice/badge.svg)](https://docs.rs/lightning-invoice/)
+
+This repo provides data structures for BOLT 11 lightning invoices and
+functions to parse and serialize these from and to bech32.
+
+**Please be sure to run the test suite since we need to check assumptions
+regarding `SystemTime`'s bounds on your platform. You can also call `check_platform`
+on startup or in your test suite to do so.**