From 64b2eaa3b7d9430b677fb45032e481566ac92bd8 Mon Sep 17 00:00:00 2001 From: Alexis Bourget Date: Thu, 15 Oct 2020 22:42:10 +0200 Subject: [PATCH] Added a changelog and updated the readme --- CHANGELOG.md | 16 ++++++++++++++++ README.md | 4 +++- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f08ce2f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Version 1.0.1 + +Git tag: `v1.0.1`. + +- Added `--quiet` (`-q`) to suppress changes output. +- Added `--version` to display crate version. +- Filenames are now only displayed when there are changes for the file. +- Filenames are now only displayed once the file has been read and the changes + found. If an error occurs when reading or finding changes, the filename + underlined by `=`s will not be displayed. + +# Version 1.0.0 + +Git tag: `v1.0.0`. + +First published version and start of the changelog. diff --git a/README.md b/README.md index bfcba1d..e579103 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ crates) was the following, the path depending on the current and target files: It is now possible to write them with Rust paths, depending on the path of the targeted item and what's in scope (which means items like `String` which are in -the prelude are just a ```[`String`]``` away). Those links are clearer for both +the prelude are just a `[String]` away). Those links are clearer for both the person writing them in the first place and subsequent readers reviewing them. They are also easier to reason about since file hierachy does not affect them. @@ -57,6 +57,8 @@ $ cargo intraconv path/to/std/file.rs -a # Applying the changes $ cargo intraconv path/to/my/file.rs -d # Disambiguate links by prefixing them # with their rustdoc group ('type@', ...) + +$ cargo intraconv path/to/my/file.rs -q # Do not display changes, only errors ``` It is possible to give multiple paths to files. Note that directories will not