From 58ee89937c15c442f13a30281c59acecab17d42a Mon Sep 17 00:00:00 2001 From: Kerem Sevencan Date: Wed, 14 Apr 2021 16:08:41 +0200 Subject: [PATCH] update readme md --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 45 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index df07e5f..6f953e6 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,18 @@ USAGE # Commands -* [`adr-tool hello [FILE]`](#adr-tool-hello-file) +* [`adr-tool create [TITLE]`](#adr-tool-create-title) * [`adr-tool help [COMMAND]`](#adr-tool-help-command) +* [`adr-tool init`](#adr-tool-init) +* [`adr-tool toc`](#adr-tool-toc) -## `adr-tool hello [FILE]` +## `adr-tool create [TITLE]` -describe the command here +create a new decision and log it into docs/adr/README.md file ``` USAGE - $ adr-tool hello [FILE] + $ adr-tool create [TITLE] OPTIONS -f, --force @@ -45,11 +47,11 @@ OPTIONS -n, --name=name name to print EXAMPLE - $ adr-tool hello - hello world from ./src/hello.ts! + $ adr-tool create use-adr-tool + a decision created on ./docs/adr/0001-use-adr-tool.md ``` -_See code: [src/commands/hello.ts](https://github.com/keremciu/adr-tool/blob/v0.0.0/src/commands/hello.ts)_ +_See code: [src/commands/create.ts](https://github.com/keremciu/adr-tool/blob/v0.0.0/src/commands/create.ts)_ ## `adr-tool help [COMMAND]` @@ -67,4 +69,40 @@ OPTIONS ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_ + +## `adr-tool init` + +create docs/adr folder and copies template.md and README.md + +``` +USAGE + $ adr-tool init + +OPTIONS + -h, --help show CLI help + +EXAMPLE + $ adr-tool init + ./docs/adr folder is created! +``` + +_See code: [src/commands/init.ts](https://github.com/keremciu/adr-tool/blob/v0.0.0/src/commands/init.ts)_ + +## `adr-tool toc` + +create docs/adr/README.md file + +``` +USAGE + $ adr-tool toc + +OPTIONS + -h, --help show CLI help + +EXAMPLE + $ adr-tool toc + ./docs/adr/README.md file is created! +``` + +_See code: [src/commands/toc.ts](https://github.com/keremciu/adr-tool/blob/v0.0.0/src/commands/toc.ts)_