Move usage example to README an include it in module docs

README.md

@@ -28,6 +28,20 @@ originally created by Brandon Liu for Protomaps.
 
 PRs welcome!
 
+## Usage examples
+
+### Writing a PMTiles file
+
+```rust
+use pmtiles::{PmTilesWriter, TileType};
+use std::fs::File;
+
+let file = File::create("tiles.pmtiles").unwrap();
+let mut writer = PmTilesWriter::new(TileType::Mvt).create(file).unwrap();
+writer.add_tile(0, &[/*...*/]).unwrap();
+writer.finish().unwrap();
+```
+
 ## Development
 * This project is easier to develop with [just](https://github.com/casey/just#readme), a modern alternative to `make`. Install it with `cargo install just`.
 * To get a list of available commands, run `just`.

src/lib.rs

@@ -1,19 +1,4 @@
-//! Read and write `PMTiles` according to the [PMTiles v3 spec](https://github.com/protomaps/PMTiles/blob/master/spec/v3/spec.md).
-//!
-//! ## Writing a `PMTiles` file
-//!
-//! ```rust
-//! use pmtiles::{PmTilesWriter, TileType};
-//! use std::fs::File;
-//!
-//! # let tile_0_0_0 = vec![];
-//! let file = File::create("tiles.pmtiles").unwrap();
-//! let mut writer = PmTilesWriter::new(TileType::Mvt).create(file).unwrap();
-//! writer.add_tile(0, &tile_0_0_0).unwrap();
-//! writer.finish().unwrap();
-//! ```
-//!
-
+#![cfg_attr(feature = "default", doc = include_str!("../README.md"))]
 #![forbid(unsafe_code)]
 
 #[cfg(feature = "__async")]