diff --git a/README.md b/README.md index 5c029a7..40aa5e6 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,13 @@ easy CLI for ADR docs You can install it globally (`npm install -g adr-tool`) or use it with [npx](https://docs.npmjs.com/cli/v7/commands/npx) - ```sh-session $ npx adr-tool init ./docs/adr folder is created! USAGE $ npx adr-tool create 'Use Markdown Architectural Decision Records' -... +a decision created on ./docs/adr/0000-use-markdown-architectural-decision-records.md ``` - # Commands * [`adr-tool create [TITLE]`](#adr-tool-create-title) @@ -50,7 +48,7 @@ EXAMPLE a decision created on ./docs/adr/0001-use-adr-tool.md ``` -_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/create.ts)_ +_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.0.8/src/commands/create.ts)_ ## `adr-tool help [COMMAND]` @@ -85,7 +83,7 @@ EXAMPLE ./docs/adr folder is created! ``` -_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/init.ts)_ +_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.8/src/commands/init.ts)_ ## `adr-tool toc` @@ -103,5 +101,5 @@ EXAMPLE ./docs/adr/README.md file is created! ``` -_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/toc.ts)_ +_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.8/src/commands/toc.ts)_ diff --git a/package.json b/package.json index bc9704a..c86970e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "adr-tool", "description": "easy CLI for ADR docs", - "version": "0.0.7", + "version": "0.0.8", "author": "Kerem Sevencan @keremciu", "bin": { "adr-tool": "./bin/run" diff --git a/templates/toc.md b/templates/toc.md index 846cc02..e8091b5 100644 --- a/templates/toc.md +++ b/templates/toc.md @@ -1,6 +1,6 @@ # Architectural Decision Log -This log lists the architectural decisions for {project}. +This log lists the architectural decisions for this project.