Bump version

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0] - 2023-06-11
+### Breaking Changes
+-   Support changed to TypeDoc versions 0.24.8 and above because we need a new TypeDoc event to fix a bug properly.
+### Added
+-   You can now define a replacer function in your config that is called for each pattern match. (see Issue #4 on GH)
+### Fixed
+-   Option `inIncludedFiles` is too greedy and overrides the other options when set to `true`. (see Issue #5 on GH)
+
 ## [2.2.0] - 2023-04-15
 ### Changes
 -   Added support for latest TypeDoc version 0.24.x.
@@ -22,7 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.0] - 2022-04-07
 First release
 
-[unreleased]: https://github.com/krisztianb/typedoc-plugin-replace-text/compare/v2.2.0...HEAD
+[unreleased]: https://github.com/krisztianb/typedoc-plugin-replace-text/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/krisztianb/typedoc-plugin-replace-text/releases/tag/v3.0.0
 [2.2.0]: https://github.com/krisztianb/typedoc-plugin-replace-text/releases/tag/v2.2.0
 [2.1.0]: https://github.com/krisztianb/typedoc-plugin-replace-text/releases/tag/v2.1.0
 [2.0.0]: https://github.com/krisztianb/typedoc-plugin-replace-text/releases/tag/v2.0.0

README.md

@@ -6,8 +6,8 @@ This is a plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that repla
 
 This includes:
 
--   Text in code comments
--   Text in the main README
+-   Text in code comments (eg: method descriptions and method parameter descriptions)
+-   Text in the main README that is used by TypeDoc
 -   Text in [included markdown files](https://typedoc.org/guides/options/#includes)
 
 You can specify matching patterns and the text they should be replaced with or a replacer function.
@@ -17,8 +17,8 @@ This can be useful for:
 -   Creating links from ticket IDs (eg: replace "GH-12345" with a link to https://github.com/your-name/the-repo/issues/12345)
 -   Creating links from author names (eg: link "Your Name" to your GitHub or corporate profile page)
 -   Replacing internal URLs (domains) with external ones
--   Replacing custom placeholders with anything you like (eg: images)
--   Removing URLs or other text from your documentation
+-   Replacing custom placeholders with anything you like (eg: images or content from external files)
+-   Removing URLs, user names, passwords or other text from your documentation
 -   etc.
 
 ## Installation
@@ -31,10 +31,7 @@ $ npm install --save-dev typedoc-plugin-replace-text
 
 ## Requirements
 
-The plugin requires TypeDoc version 0.23.x or 0.24.x to be installed.
-
-Version **0.23.x** of TypeDoc automatically detects plugins installed via npm.
-If you are using version **0.24.x** of TypeDoc you need to [activate the plugin with the plugin option](https://typedoc.org/options/configuration/#plugin) in your TypeDoc config.
+The plugin requires TypeDoc version 0.24.8 or above to be installed. You need to [activate the plugin with the plugin option](https://typedoc.org/options/configuration/#plugin) in your TypeDoc config.
 
 After installation TypeDoc can be used normally and you can configure this plugin as described below.