Merge pull request #212 from stepchowfun/wordsmithing

Do some wordsmithing on the README and the help text

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.9.1] - 2024-02-21
+
+### Fixed
+- Fixed a typo in the help text.
+
 ## [1.9.0] - 2024-02-21
 
 ### Added

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tagref"
-version = "1.9.0"
+version = "1.9.1"
 authors = ["Stephan Boyer <[email protected]>"]
 edition = "2021"
 description = "Tagref helps you maintain cross-references in your code."

README.md

@@ -28,18 +28,18 @@ To help you manage these tags and references, Tagref checks the following:
 1. References actually point to tags. A tag cannot be deleted or renamed without updating the references that point to it.
 2. Tags are unique. There is never any ambiguity about which tag is being referenced.
 
-In the example above, Tagref won't ensure that `cities` is actually non-empty. It isn't magic! It only checks the two criteria above.
+In the example above, Tagref doesn't ensure that `cities` is actually non-empty. It isn't magic! It only checks the two criteria above.
 
 In addition to references to tags, Tagref also supports *file references* and *directory references*. A file reference guarantees that the given file exists. For example:
 
-```markdown
-The program entrypoint is located in [file:src/main.rs].
+```python
+# If you bump the version, be sure to update [file:CHANGELOG.md].
 ```
 
 A directory reference guarantees that the given directory exists. For example:
 
-```markdown
-All of the files in [dir:src] must be formatted by `rustfmt`.
+```python
+# This script will format the files in [dir:src].
 ```
 
 ## Usage

src/main.rs

@@ -70,9 +70,9 @@ fn settings() -> Settings {
             "\
              Tagref helps you maintain cross-references in your code.\n\
              \n\
-             You can put tags like [tag:foo] in your code (in comments), and you can reference \
-             them like [ref:foo]. You can also references files like [file:src/main.rs] and \
-             directories like [dir:src].\n\
+             You can annotate your code with tags like [tag:foo] and reference them like \
+             [ref:foo]. You can also reference files like [file:src/main.rs] and directories like \
+             [dir:src].\n\
              \n\
              Tagref checks that tags are unique and that references are not dangling.\n\
              \n\