metadata

4 files changed, 50 insertions, 0 deletions

diff --git a/Cargo.toml b/Cargo.toml
index 59166a7..39d925f 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -4,6 +4,13 @@ version = "0.1.0"
 authors = ["Jesse Luehrs <doy@tozt.net>"]
 edition = "2018"
 
+description = "reads and writes ttyrec files"
+license = "MIT"
+repository = "https://git.tozt.net/ttyrec"
+readme = "README.md"
+keywords = ["ttyrec"]
+categories = ["parser-implementations"]
+
 [dependencies]
 futures = "0.1.29"
 snafu = "0.5"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..fda0fd2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,32 @@
+This software is Copyright (c) 2019 by Jesse Luehrs.
+
+This is free software, licensed under:
+
+  The MIT (X11) License
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to
+whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall
+be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
+WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fdfef97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# ttyrec
+
+This crate contains helpers for reading and writing
+[ttyrec](https://en.wikipedia.org/wiki/Ttyrec) files.
+
+`Parser` and `Creator` can be used to read and write files manually, and
+`Reader` and `Writer` are helpers to provide a nicer API for asynchronous
+applications using `tokio`.
diff --git a/src/lib.rs b/src/lib.rs
index 3f8e745..5ae78fa 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -5,9 +5,12 @@
 //! `Reader` and `Writer` are helpers to provide a nicer API for asynchronous
 //! applications using `tokio`.
 
+// XXX this is broken with ale
+// #![warn(clippy::cargo)]
 #![warn(clippy::pedantic)]
 #![warn(clippy::nursery)]
 #![allow(clippy::missing_const_for_fn)]
+#![allow(clippy::multiple_crate_versions)]
 
 mod creator;
 pub use creator::Creator;