rework crate doc & README

migrate to README.tpl to use with `cargo readme`

Cargo.toml

@@ -14,6 +14,9 @@ categories = [
 ]
 license = "LGPL-3.0-or-later"
 
+[badges]
+maintenance = { status = "actively-developed" }
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [lints.clippy]

README.tpl

@@ -0,0 +1,11 @@
+# {{crate}}
+## Current version: {{version}}
+
+{{badges}}
+[![crates.io](https://img.shields.io/crates/v/{{crate}}.svg)](https://crates.io/crates/{{crate}})
+[![docs.rs](https://docs.rs/{{crate}}/badge.svg)](https://docs.rs/{{crate}}/)
+[![dependency status](https://deps.rs/crate/{{crate}}/{{version}}/status.svg)](https://deps.rs/crate/{{crate}}/{{version}})
+
+{{readme}}
+
+## License : {{license}}

src/lib.rs

@@ -1,6 +1,16 @@
-//! This crate attempt to provide utilities to parse subtitles.
-//! Work is started from vobsub [crates.io](https://crates.io/crates/vobsub),
-//! [repository](https://github.com/emk/subtitles-rs) which no longer seems to be maintained.
+//! `subtile` is a Rust library which aims to propose a set of operations
+//! for working on subtitles. Example: parsing from and export in different formats,
+//! transform, adjust, correct, ...
+//!
+//! # Project
+//! ## start
+//! The project started with the fork of [vobsub](https://crates.io/crates/vobsub)
+//! crate which no longer seems to be maintained.
+//! Beyond the simple recovery, I want to take the opportunity to improve the code
+//! and extend the provided features.
+//!
+//! ## Name
+//! `Subtile` is a french word than fit well as contraction of Subtitles Utils.
 //!
 //! ## Contributing
 //!