Update README and LICENSE

Author: ksceriath

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "json_diff"
-version = "0.1.0"
+version = "0.1.1"
 authors = ["ksceriath"]
 edition = "2018"
 license = "Unlicense"

Cargo.toml

@@ -1,17 +1,23 @@
 # json-diff
 
-A small command line utility to compare two jsons.
+json-diff is a command line utility to compare two jsons. 
 
-Usage Example:
+Input can be fed as inline strings or through files. 
+For readability, output is neatly differentiated into three categories: keys with different values, and keys not present in either of the objects. 
+Only missing or unequal keys are printed in output to reduce the verbosity.
 
-json_diff f source1.json source2.json
+## Screenshot of diff results
 
-json_diff d '{...}' '{...}'
+[![A screenshot of a sample diff with json_diff](https://github.com/ksceriath/json-diff/blob/master/Screenshot.png)](https://github.com/ksceriath/json-diff/blob/master/Screenshot.png)
 
-Option:
+Usage Example:
 
-f : read input from json files
+`$ json_diff f source1.json source2.json` 
+`$ json_diff d '{...}' '{...}'`
+
+Option:
 
+f : read input from json files 
 d : read input from command line
 
 

README.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

Screenshot.png

@@ -1,4 +1,5 @@
 use std::fmt;
+use colored::*;
 
 #[derive(Debug)]
 pub enum Message {
@@ -31,6 +32,6 @@ impl fmt::Display for Message {
  Message::Mismatch => "Mismatched",
  };
 
- write!(f, "{}", message)
+ write!(f, "{}", message.bold())
  }
 }

UNLICENSE

@@ -93,13 +93,13 @@ fn display_output(result: Mismatch) {
  let stdout = io::stdout();
  let mut handle = io::BufWriter::new(stdout.lock());
  if no_mismatch == result {
- writeln!(handle, "{}", Message::NoMismatch).unwrap();
+ writeln!(handle, "\n{}", Message::NoMismatch).unwrap();
  } else {
  match result.keys_in_both {
  KeyNode::Node(_) => {
  let mut keys = Vec::new();
  result.keys_in_both.absolute_keys(&mut keys, None);
- writeln!(handle, "{}:", Message::Mismatch).unwrap();
+ writeln!(handle, "\n{}:", Message::Mismatch).unwrap();
  for key in keys {
  writeln!(handle, "{}", key).unwrap();
  }
@@ -111,7 +111,7 @@ fn display_output(result: Mismatch) {
  KeyNode::Node(_) => {
  let mut keys = Vec::new();
  result.left_only_keys.absolute_keys(&mut keys, None);
- writeln!(handle, "{}:", Message::LeftExtra).unwrap();
+ writeln!(handle, "\n{}:", Message::LeftExtra).unwrap();
  for key in keys {
  writeln!(handle, "{}", key.red().bold()).unwrap();
  }
@@ -123,7 +123,7 @@ fn display_output(result: Mismatch) {
  KeyNode::Node(_) => {
  let mut keys = Vec::new();
  result.right_only_keys.absolute_keys(&mut keys, None);
- writeln!(handle, "{}:", Message::RightExtra).unwrap();
+ writeln!(handle, "\n{}:", Message::RightExtra).unwrap();
  for key in keys {
  writeln!(handle, "{}", key.green().bold()).unwrap();
  }