You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-18Lines changed: 8 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,7 @@
1
1
# Jdiff
2
2
3
-
<!--
4
-
Developer Note - Remove Me!
5
-
6
-
The README will have certain links/images broken until the PR is merged into `develop`. Update the GitHub links with whichever branch you're using (main etc.) if different.
7
-
8
-
The logo of the project is a placeholder (docs/images/icon-jdiff.png) - please replace it with your app icon, making sure it's at least 200x200px and has a transparent background!
9
-
10
-
To avoid extra work and temporary links, make sure that publishing docs (or merging a PR) is done at the same time as setting up the docs site on RTD, then test everything.
@@ -22,23 +12,23 @@ To avoid extra work and temporary links, make sure that publishing docs (or merg
22
12
23
13
## Overview
24
14
25
-
> Developer Note: Add a long (2-3 paragraphs) description of what the library does, what problems it solves, etc.
15
+
`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.
26
16
27
17
## Documentation
28
18
29
19
Full documentation for this library can be found over on the [Jdiff Docs](https://jdiff.readthedocs.io/) website:
30
20
31
-
-[User Guide](https://jdiff.readthedocs.io/user/app_overview/) - Overview, Using the Library, Getting Started.
32
-
-[Administrator Guide](https://jdiff.readthedocs.io/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the Library.
33
-
-[Developer Guide](https://jdiff.readthedocs.io/dev/contributing/) - Extending the Library, Code Reference, Contribution Guide.
You can find all the Markdown source for the App documentation 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.
40
30
41
-
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://jdiff/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
31
+
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can 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). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
42
32
43
33
Any PRs with fixes or improvements are very welcome!
0 commit comments