Merge pull request Enet4#38 from robyoung/improve-readme-docs

Improve README docs

Author: Enet4

README.md

@@ -1,9 +1,14 @@
 # DICOM-rs
 
-[![Build Status](https://travis-ci.org/Enet4/dicom-rs.svg?branch=master)](https://travis-ci.org/Enet4/dicom-rs) ![Minimum Rust Version Stable](https://img.shields.io/badge/Minimum%20Rust%20Version-stable-green.svg) [![dependency status](https://deps.rs/repo/github/Enet4/dicom-rs/status.svg)](https://deps.rs/repo/github/Enet4/dicom-rs) [![Gitter](https://badges.gitter.im/dicom-rs/community.svg)](https://gitter.im/dicom-rs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Build Status](https://travis-ci.org/Enet4/dicom-rs.svg?branch=master)](https://travis-ci.org/Enet4/dicom-rs)
+![Minimum Rust Version Stable](https://img.shields.io/badge/Minimum%20Rust%20Version-stable-green.svg)
+[![dependency status](https://deps.rs/repo/github/Enet4/dicom-rs/status.svg)](https://deps.rs/repo/github/Enet4/dicom-rs)
+[![Gitter](https://badges.gitter.im/dicom-rs/community.svg)](https://gitter.im/dicom-rs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![CratesIO](https://img.shields.io/crates/v/dicom.svg)](https://crates.io/crates/dicom)
+[![Documentation](https://docs.rs/dicom/badge.svg)](https://docs.rs/dicom)
 
 
-An efficient and practical library for DICOM compliant systems.
+An efficient and practical library for [DICOM](https://dicomstandard.org) compliant systems.
 
 This collection provides a pure Rust implementation of the DICOM standard,
 allowing users to read and write DICOM objects over files and other sources, while
@@ -22,9 +27,11 @@ remaining intrinsically fast and safe to use.
 
 ## Using as a library
 
-[`dicom-object`](object) is currently the most usable crate for reading DICOM objects from a file or a similar source. As an alternative, the parent crate [`dicom`](parent) can be added instead, which aggregates the key components of the full library, including `dicom-object`.
+[`dicom-object`](object) is currently the most usable crate for reading DICOM objects from a file or a similar source.
+As an alternative, the parent crate [`dicom`](parent) can be added instead, which aggregates the key components of the
+full library, including `dicom-object`.
 
-An example of use follows. For more, please visit the respective [documentation](https://docs.rs/dicom-object).
+An example of use follows. For more details, please visit the [`dicom-object` documentation](https://docs.rs/dicom-object).
 
 ```rust
 use dicom_object::open_file;
@@ -47,7 +54,8 @@ cargo build --release
 
 This project is a work in progress, but actively developed.
 
-Your feedback during the development of these solutions is welcome. Please see the [wiki](https://github.com/Enet4/dicom-rs/wiki) for additional guidelines related to the project's roadmap.
+Your feedback during the development of these solutions is welcome. Please see the [wiki](https://github.com/Enet4/dicom-rs/wiki)
+for additional guidelines related to the project's roadmap.
 
 ## License
 

core/README.md

@@ -1,3 +1,6 @@
 # DICOM-rs core library
 
+[![CratesIO](https://img.shields.io/crates/v/dicom-core.svg)](https://crates.io/crates/dicom-core)
+[![Documentation](https://docs.rs/dicom-core/badge.svg)](https://docs.rs/dicom-core)
+
 This sub-project implements the essential data structures and mechanisms for dealing with DICOM information and communication formats. This crate is used by other crates in DICOM-rs.

dcmdump/README.md

@@ -0,0 +1,9 @@
+# dcmdump
+
+A command line utility for inspecting DICOM files.
+
+## Usage
+
+```shell
+> dcmdump [FILE]
+```

dictionary-builder/README.md

@@ -1,5 +1,8 @@
 # DICOM Dictionary Builder
 
+[![CratesIO](https://img.shields.io/crates/v/dicom-dictionary-builder.svg)](https://crates.io/crates/dicom-dictionary-builder)
+[![Documentation](https://docs.rs/dicom-dictionary-builder/badge.svg)](https://docs.rs/dicom-dictionary-builder)
+
 This sub-project is a tool for generating machine readable attribute dictionaries from the DICOM standard.
 
 ## Building

dictionary-std/README.md

@@ -1,3 +1,6 @@
 # DICOM-rs standard dictionary
 
-This sub-project uses entries generated by the [dictionary_builder](../dictionary_builder) to provide the standard DICOM data dictionary.
+[![CratesIO](https://img.shields.io/crates/v/dicom-dictionary-std.svg)](https://crates.io/crates/dicom-dictionary-std)
+[![Documentation](https://docs.rs/dicom-dictionary-std/badge.svg)](https://docs.rs/dicom-dictionary-std)
+
+This sub-project uses entries generated by the [`dictionary_builder`](../dictionary_builder) to provide the standard DICOM data dictionary.

encoding/README.md

@@ -0,0 +1,6 @@
+# DICOM-rs encoding library
+
+[![CratesIO](https://img.shields.io/crates/v/dicom-encoding.svg)](https://crates.io/crates/dicom-encoding)
+[![Documentation](https://docs.rs/dicom-core/badge.svg)](https://docs.rs/dicom-core)
+
+This sub-project provides DICOM data encoding and decoding primitives.

object/README.md

@@ -1,3 +1,9 @@
 # DICOM-rs object library
 
-This sub-project is directed at the user of the DICOM-rs ecosystem. It provides a high-level abstraction to DICOM objects, enabling objects to be retrieved from files or other common sources, and then analysed as a tree of attributes.
+[![CratesIO](https://img.shields.io/crates/v/dicom-object.svg)](https://crates.io/crates/dicom-object)
+[![Documentation](https://docs.rs/dicom-object/badge.svg)](https://docs.rs/dicom-object)
+
+This sub-project is directed at users of the DICOM-rs ecosystem. It provides a high-level
+abstraction to DICOM objects, enabling objects to be retrieved from files or
+['readers'](https://doc.rust-lang.org/std/io/trait.Read.html), and then analysed as a tree
+of attributes.

parser/README.md

@@ -1,4 +1,7 @@
 # DICOM-rs parser library
 
+[![CratesIO](https://img.shields.io/crates/v/dicom-parser.svg)](https://crates.io/crates/dicom-parser)
+[![Documentation](https://docs.rs/dicom-parser/badge.svg)](https://docs.rs/dicom-parser)
+
 This sub-project implements the mechanisms for encoding, decoding and parsing DICOM content.