Add Readme and License

Author: jan-auer

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "dynfmt"
 version = "0.1.0"
-authors = ["Jan Michael Auer"]
+authors = ["Jan Michael Auer <[email protected]>"]
 edition = "2018"
 readme = "README.md"
 repository = "https://github.com/jan-auer/dynfmt"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jan Michael Auer
+
+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.

README.md

@@ -0,0 +1,20 @@
+# dynfmt - Dynamic Formatting in Rust
+
+`dynfmt` provides several implementations for formats that implement a subset of
+the [`std::fmt`] facilities. Parsing of the format string and arguments checks
+are performed at runtime. There is also the option to implement new formats.
+
+The public API is exposed via the [`Format`] trait, which contains formatting
+helper functions and lower-level utilities to interface with format strings. See
+the Features section for a list of provided implementations.
+
+## Usage
+
+```rust
+use dynfmt::{Format, NoopFormat};
+
+let formatted = NoopFormat.format("hello, world", &["unused"]);
+assert_eq!("hello, world", formatted.expect("formatting failed"));
+```
+
+See the [Documentation](https://docs.rs/dynfmt) for more information.