fix readmine

Author: jeffkala

README.md

@@ -1,39 +1,37 @@
-# jdiff
+# Jdiff
 
-`jdiff` is a lightweight Python library allowing you to examine structured data. `jdiff` provides an interface to intelligently compare--via key presense/absense and value comparison--JSON data objects
+<p align="center">
+  <img src="https://raw.githubusercontent.com/networktocode/jdiff/develop/docs/images/jdiff_logo.png" class="logo" height="200px">
+  <br>
+  <a href="https://github.com/networktocode/jdiff/actions"><img src="https://github.com/networktocode/jdiff/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <a href="https://jdiff.readthedocs.io/en/latest"><img src="https://readthedocs.org/projects/jdiff/badge/"></a>
+  <a href="https://pypi.org/project/jdiff/"><img src="https://img.shields.io/pypi/v/jdiff"></a>
+  <a href="https://pypi.org/project/jdiff/"><img src="https://img.shields.io/pypi/dm/jdiff"></a>
+  <br>
+</p>
 
-Our primary use case is the examination of structured data returned from networking devices, such as:
+## Overview
 
-* Compare the operational state of network devices pre and post change
-* Compare operational state of a device vs a "known healthy" state
-* Compare state of similar devices, such as a pair of leafs or a pair of backbone routers
-* Compare operational state of a component (interface, vrf, bgp peering, etc.) migrated from one device to another
+`jdiff` is a lightweight Python library allowing you to examine structured data. `jdiff` provides an interface to intelligently compare JSON data objects and test for the presence (or absence) of keys. You can also examine and compare corresponding key-values.
 
-However, the library fits other use cases where structured data needs to be operated on.
-
-## Installation 
-
-Install from PyPI:
-
-```
-pip install jdiff
-```
+## Documentation
 
-## Intelligent Comparison
+Full web-based HTML documentation for this library can be found over on the [Jdiff Docs](https://jdiff.readthedocs.io) website:
 
-The library provides the ability to ask more intelligent questions of a given data structure. Comparisons of data such as "Is my pre change state the same as my post change state", is not that interesting of a comparison. The library intends to ask intelligent questions _like_:
+- [User Guide](https://jdiff.readthedocs.io/en/latest/user/lib_overview/) - Overview, Using the library, Getting Started.
+- [Administrator Guide](https://jdiff.readthedocs.io/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the library.
+- [Developer Guide](https://jdiff.readthedocs.io/en/latest/dev/contributing/) - Extending the library, Code Reference, Contribution Guide.
+- [Release Notes / Changelog](https://jdiff.readthedocs.io/en/latest/admin/release_notes/).
+- [Frequently Asked Questions](https://jdiff.readthedocs.io/en/latest/user/faq/).
 
-* Is the route table within 10% of routes before and after a change?
-* Is all of the interfaces that were up before the change, still up?
-* Are there at least 10k sessions of traffic on my firewall?
-* Is there there at least 2 interfaces up within lldp neighbors?
+### Contributing to the Docs
 
-## Technical Overview
+All the Markdown source for the library documentation can be found under the [docs](https://github.com/networktocode/jdiff/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.
 
-The library heavily relies on [JMESPath](https://jmespath.org/) for traversing the JSON object and finding the values to be evaluated. More on that [here](#customized-jmespath).
+If you need to view the fully generated documentation site, you can build it with [mkdocs](https://www.mkdocs.org/). A container hosting the docs will be started using the invoke commands (details in the [Development Environment Guide](https://jdiff.readthedocs.io/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). As your changes are saved, the live docs will be automatically reloaded.
 
-`jdiff` has been developed around diffing and testing structured data returned from Network APIs and libraries (such as TextFSM) but is equally useful when working or dealing with data returned from APIs.
+Any PRs with fixes or improvements are very welcome!
 
-## Documentation
+## Questions
 
-Documentation is hosted on Read the Docs at [jdiff Documentation](https://jdiff.readthedocs.io/).
+For any questions or comments, please check the [FAQ](https://jdiff.readthedocs.io/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#networktocode`), sign up [here](http://slack.networktocode.com/) if you don't have an account.