Add README and license

Author: Marcus Ewert

Cargo.toml

@@ -2,6 +2,7 @@
 name = "qjsonrs"
 version = "0.1.0"
 authors = ["Marcus Ewert <[email protected]>"]
+license = "MIT"
 edition = "2018"
 
 [dependencies]

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Marcus Henry Ewert
+
+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,34 @@
+# qjsonrs
+
+A Rust implementation of a JSON Tokenizer.
+
+## Motivation
+
+Streaming tokenization for handling large JSON payloads which can be processed
+without loading the whole JSON object into memory.
+
+## Iterator interface.
+
+The steam of JsonTokens emitted by this crate unfortunately cannot quite
+provide the Iter interface. The reason is: the emitted JsonTokens refer to an
+internal buffer of the stream, and thus maintain a reference to the stream.
+
+Also, the iterator returns Results, to enable reporting of IO or JSON encoding errors.
+
+## Example:
+
+```rust
+use qjsonrs::{
+    JsonStream,
+    JsonToken::JsBoolean
+}
+
+let mut stream = JsonStream::from_read(file)?;
+while Some(t) = stream.next()? {
+  match t {
+    JsonToken::JsBoolean(b) => { println!("Got JSON boolean: {:?}", b) },
+    o => { println!("Got other JSON token boolean: {:?}", o) },
+  }
+}
+println!("Done reading stream.");
+```