diff --git a/Cargo.toml b/Cargo.toml index 3dc3166..fc1546a 100644 --- a/Cargo.toml +++ b/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] diff --git a/README.md b/README.md deleted file mode 100644 index 2d22449..0000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# subtile -`subtile` is a Rust library which aims to propose a set of operations for working on subtitles. Example: open or export in different formats, transform, adjust, correct, ... - -## start -The project start with the fork of [vobsub](https://crates.io/crates/vobsub) crate. As vobsub is no longer maintained, and I want to extend the features. - -## Name -`Subtile` is a french word than fit well as contraction of Subtitles Utils. diff --git a/README.tpl b/README.tpl new file mode 100644 index 0000000..b84a4d9 --- /dev/null +++ b/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}} diff --git a/src/lib.rs b/src/lib.rs index 9f9edd3..959d512 100644 --- a/src/lib.rs +++ b/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 //!