Clean up the README and convert to markdown for publishing to crates.io

This commit is contained in:
R Tyler Croy 2021-05-23 10:05:24 -07:00
parent bf0cea352e
commit 0c3ac34986
4 changed files with 11 additions and 2 deletions

2
.gitignore vendored
View File

@ -1,3 +1,5 @@
/target
Cargo.lock
*.sw*
README.xml
README.md

View File

@ -1,6 +1,6 @@
[package]
name = "xmltojson"
version = "0.1.0"
version = "0.1.1"
authors = ["R. Tyler Croy <rtyler@brokenco.de>"]
edition = "2018"
description = "A simple crate for converting XML to JSON"
@ -8,6 +8,7 @@ homepage = "https://github.com/rtyler/xmltojson"
repository = "https://github.com/rtyler/xmltojson"
license = "LGPL-3.0+"
keywords = ["xml", "json"]
readme = "README.md"
[dependencies]
log = "0"

6
Makefile Normal file
View File

@ -0,0 +1,6 @@
README.md: README.adoc
asciidoc -b docbook README.adoc && pandoc -f docbook -t markdown_mmd -o README.md README.xml
clean:
rm -f README.md README.xml

View File

@ -2,7 +2,7 @@
A Rust crate implementing
link:https://goessner.net/download/prj/jsonxml/[Stefan Goessner's xml2json]
design. This can be very useful for turning XML data into JSON for processing in JSON data stores or engines such as Elasticsearch or PostgreSQL ()`JSON`/`JSONB`).
design. This can be very useful for turning XML data into JSON for processing in JSON data stores or engines such as Elasticsearch or PostgreSQL (`JSON`/`JSONB`).
See the tests in `src/lib.rs` for examples of how XML gets converted to JSON structures