Skip to content
This repository has been archived by the owner on Apr 13, 2022. It is now read-only.

Commit

Permalink
update readme md
Browse files Browse the repository at this point in the history
  • Loading branch information
keremciu committed Apr 14, 2021
1 parent 7b7f73d commit 58ee899
Showing 1 changed file with 45 additions and 7 deletions.
52 changes: 45 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,30 @@ USAGE
<!-- usagestop -->
# Commands
<!-- 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
-h, --help show CLI help
-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]`

Expand All @@ -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)_
<!-- commandsstop -->

0 comments on commit 58ee899

Please sign in to comment.