diff --git a/README.md b/README.md index 9ac7dce..5c029a7 100644 --- a/README.md +++ b/README.md @@ -41,16 +41,16 @@ USAGE $ adr-tool create [TITLE] OPTIONS - -h, --help show CLI help - -t, --ticket=ticket technical ticket - --status=proposed|rejected|accepted|deprecated|superseeded + -h, --help show CLI help + -t, --ticket=ticket technical ticket + --status=accepted|deprecated|superseeded EXAMPLE - $ adr-tool create use-adr-tool + $ adr-tool create 'Use ADR Tool' 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.6/src/commands/create.ts)_ +_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/create.ts)_ ## `adr-tool help [COMMAND]` @@ -85,7 +85,7 @@ EXAMPLE ./docs/adr folder is created! ``` -_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.6/src/commands/init.ts)_ +_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/init.ts)_ ## `adr-tool toc` @@ -103,5 +103,5 @@ EXAMPLE ./docs/adr/README.md file is created! ``` -_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.6/src/commands/toc.ts)_ +_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.7/src/commands/toc.ts)_ diff --git a/package.json b/package.json index b7fba35..bc9704a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "adr-tool", "description": "easy CLI for ADR docs", - "version": "0.0.6", + "version": "0.0.7", "author": "Kerem Sevencan @keremciu", "bin": { "adr-tool": "./bin/run" diff --git a/src/commands/create.ts b/src/commands/create.ts index a2c584c..ef6652f 100644 --- a/src/commands/create.ts +++ b/src/commands/create.ts @@ -31,13 +31,13 @@ function getLatestIndex(): number { return decisionFiles.length } -const statusOptions = ['proposed', 'rejected', 'accepted', 'deprecated', 'superseeded'] +const statusOptions = ['accepted', 'deprecated', 'superseeded'] export default class Create extends Command { static description = 'create a new decision and log it into docs/adr/README.md file' static examples = [ - `$ adr-tool create use-adr-tool + `$ adr-tool create 'Use ADR Tool' a decision created on ./docs/adr/0001-use-adr-tool.md `, ] diff --git a/templates/template.md b/templates/template.md index ff6015e..65a0f08 100644 --- a/templates/template.md +++ b/templates/template.md @@ -1,6 +1,6 @@ # [short title of solved problem and solution] -* Status: [proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)] +* Status: [accepted | deprecated | superseded by [ADR-0005](0005-example.md)] * Deciders: [list everyone involved in the decision] * Date: [YYYY-MM-DD when the decision was last updated] * Template used: [MADR 3.0.0](https://adr.github.io/madr/) @@ -70,4 +70,6 @@ Chosen option: "[option 1]", because [justification. e.g., only option, which me ## Links * [Link type] [Link to ADR] -* … \ No newline at end of file +* … + + \ No newline at end of file