doc: generate README and add crate doc comment

README.md

@@ -1,14 +1,15 @@
-<h1 align="center">distance-field</h1>
-<p align="center">
-A Rust library/executable for generating distance field bitmaps to render as pseudo-vector images in a shader
-</p>
-
-<p align="center">
-	<a href="https://github.com/tversteeg/distance-field/actions"><img src="https://github.com/tversteeg/distance-field/workflows/rust/badge.svg" alt="CI"/></a>
-	<a href="https://crates.io/crates/distance-field"><img src="https://img.shields.io/crates/v/distance-field.svg" alt="Version"/></a>
-	<a href="https://docs.rs/distance-field"><img src="https://img.shields.io/badge/api-rustdoc-blue.svg" alt="Rust Documentation"/></a>
-	<img src="https://img.shields.io/crates/l/distance-field.svg" alt="License"/>
-</p>
+# distance-field
+
+[![Build Status](https://github.com/tversteeg/distance-field/workflows/CI/badge.svg)](https://github.com/tversteeg/distance-field/actions?workflow=CI)
+[![Crates.io](https://img.shields.io/crates/v/distance-field.svg)](https://crates.io/crates/distance-field)
+[![Documentation](https://docs.rs/distance-field/badge.svg)](https://docs.rs/distance-field)
+[![License: GPL-3.0](https://img.shields.io/crates/l/distance-field.svg)](#license)
+[![Downloads](https://img.shields.io/crates/d/distance-field.svg)](#downloads)
+
+### [Documentation](https://docs.rs/distance-field/)
+
+<!-- cargo-rdme start -->
+<!-- cargo-rdme end -->
 
 # Generator binary
 
@@ -38,44 +39,3 @@ Then we apply a treshold function:
 
 You can see that we have something which looks very similar to the original input image and that just from a 64x64 image! But it's still very pixelated and doesn't look like a vector image. This can be fixed by not doing a hard treshold but allowing some shades of gray.
 
-# Library
-
-An example usecase for the library would be to automatically convert asset images. You can achieve this by having a `build.rs` similar to this:
-
-```rust
-extern crate image;
-extern crate distance_field;
-
-use std::fs::File;
-use distance_field::DistanceFieldExt;
-
-fn convert_image_to_dfield(input: &str, output: &str) {
-    // Load the 'input' image
-    let img = image::open(input).unwrap();
-
-    // Generate a distance field from the image
-    let outbuf = img.grayscale().distance_field(distance_field::Options {
-        size: (128, 128),
-        max_distance: 256,
-        ..Default::default()
-    });
-
-    // Save it to 'output' as a PNG
-    image::DynamicImage::ImageLuma8(outbuf).save(output).unwrap();
-}
-
-fn main() {
-    convert_image_to_dfield("img/input.png", "output.png");
-}
-```
-
-And adding the following to `Cargo.toml`:
-
-```toml
-[packages]
-build = "build.rs"
-
-[build-dependencies]
-distance-field = "0.1"
-image = "0.22"
-```

src/lib.rs

@@ -1,3 +1,31 @@
+//! Generate distance field bitmaps for rendering as pseudo-vector images in shaders.
+//!
+//! An example usecase for the library would be to automatically convert asset images. You can achieve this by having a `build.rs` similar to this:
+//!
+//! ```rust
+//! use std::fs::File;
+//! use distance_field::DistanceFieldExt;
+//!
+//! fn convert_image_to_dfield(input: &str, output: &str) {
+//!     // Load the 'input' image
+//!     let img = image::open(input).unwrap();
+//!
+//!     // Generate a distance field from the image
+//!     let outbuf = img.grayscale().distance_field(distance_field::Options {
+//!         size: (128, 128),
+//!         max_distance: 256,
+//!         ..Default::default()
+//!     });
+//!
+//!     // Save it to 'output' as a PNG
+//!     image::DynamicImage::ImageLuma8(outbuf).save(output).unwrap();
+//! }
+//!
+//! fn main() {
+//!     convert_image_to_dfield("img/input.png", "output.png");
+//! }
+//! ```
+
 use bitvec::vec::BitVec;
 use image::{DynamicImage, ImageBuffer, Luma};
 use spiral::ManhattanIterator;