basic README and copyright texts

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0a482a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# hohibe — Hierarchical Identity Based Encryption
+
+This crate provides an implementation of hierarchical identity based encryption
+for Rust. For more information, please see the crate documentation (run `cargo
+doc` to generate it).
+
+
+## ⚠️ Warning: Cryptographic Hazmat ☣️
+
+This crate is made for playing around with HIBE and for prototyping of applications and
+protocols using HIBE. It has *not* been audited, it is *not* battle tested, and *nobody* claims
+it to be secure.
+
+Use it at **your own risk** and if you know what you are doing!
+
+## License
+
+hohibe is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+hohibe is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with Foobar. If not, see <https://www.gnu.org/licenses/>.