Skip to content

Commit 6a7244f

Browse files
committed
docs(README): Add changelog to README
1 parent 0bbd48a commit 6a7244f

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ A tool for generating documentation/help menu for user defined bash functions.
88
edition = "2018"
99
homepage = "https://github.com/dustinknopoff/bashdoc"
1010
repository = "https://github.com/dustinknopoff/bashdoc"
11+
documentation = "https://docs.rs/crate/bashdoc"
1112
readme = "README.md"
1213
keywords = ["bash", "docs", "documentation"]
1314
categories = ["command-line-utilities", "text-processing"]

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,12 @@ See the [examples](https://github.com/dustinknopoff/bashdoc/tree/master/example)
9595

9696
See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGELOG.md) for updates
9797

98+
## Changelog
99+
100+
- v0.4.0 - Added to crates.io
101+
- v0.4.1/v0.4.2 - Better descriptions for crates.io
102+
- v.0.4.5 - Fix error where bashdoc would not function for users without a `~/.bashdocrc`
103+
- v.0.4.6 - Improved Error handling, `--html` argument removed replaced with `--location`, `--template` argument added for supplying custom `.hbs`
104+
- v0.4.7 - Fix required location for all inputs and not exclusive to `--location`
105+
98106
License: MIT

src/main.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@
9292
//! See the [examples](https://github.com/dustinknopoff/bashdoc/tree/master/example) folder for more.
9393
//!
9494
//! See the [changelog](https://github.com/dustinknopoff/bashdoc/blob/master/CHANGELOG.md) for updates
95+
//!
96+
//! # Changelog
97+
//!
98+
//!- v0.4.0 - Added to crates.io
99+
//!- v0.4.1/v0.4.2 - Better descriptions for crates.io
100+
//!- v.0.4.5 - Fix error where bashdoc would not function for users without a `~/.bashdocrc`
101+
//!- v.0.4.6 - Improved Error handling, `--html` argument removed replaced with `--location`, `--template` argument added for supplying custom `.hbs`
102+
//!- v0.4.7 - Fix required location for all inputs and not exclusive to `--location`
95103
mod docs;
96104
use crate::docs::runners::*;
97105
use clap::{load_yaml, App};

0 commit comments

Comments
 (0)