Refine CHANGELOG.md and REAMDE.md

adr · Oct 21, 2020 · fc1dbb0 · fc1dbb0
1 parent 07b7acf
commit fc1dbb0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,9 @@ We refer to [GitHub issues](https://github.com/adr/adr-log/issues) by using `#NU
 ### Added
 
 - New option `-p` - prefix for each ADR file path in log (useful when ADRs are in sub sub directory)
+- New option `-e` option to specify glob pattern for files to be excluded
+- Allow date prefixes as well as number prefixes
+- Allow specification of `index` or `date` properties in frontmatter
 
 ### Fixed
 
@@ -20,6 +23,7 @@ We refer to [GitHub issues](https://github.com/adr/adr-log/issues) by using `#NU
 ### Changed
 
 - Lists are now generated using `*` instead of `-`
+- Search recursively underneath the given directory
 
 ## [2.1.3] – 2019-11-15
 

diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@
 Install with [npm](https://www.npmjs.com/):
 
 ```sh
-$ npm install -g adr-log
+npm install -g adr-log
 ```
 
 ## CLI
@@ -55,7 +55,7 @@ Consider a directory consisting of three files (`0000-example-1.md`, `0001-examp
 Execute following command:
 
 ```sh
-$ adr-log -d .
+adr-log -d .
 ```
 
 This outputs following log on your console:
@@ -91,6 +91,13 @@ Result in following `index.md`:
 <!-- adrlogstop -->
 ```
 
+### Alternative Indexing
+
+- search recursively underneath the given directory
+- allow date prefixes as well as number prefixes
+- allow specification of `index` or `date` properties in frontmatter
+- fallback to auto-numbering for ADRs without filename prefixes or frontmatter
+
 ## Developing
 
 - Run `node cli.js` to execute the CLI.