Skip to content

Commit

Permalink
Added a changelog and updated the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
poliorcetics committed Oct 15, 2020
1 parent 109fa07 commit 64b2eaa
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 64b2eaa

Please sign in to comment.