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

Commit

Permalink
update toc template
Browse files Browse the repository at this point in the history
  • Loading branch information
keremciu committed Apr 14, 2021
1 parent b364efc commit 35175e1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- usage -->
```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
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`adr-tool create [TITLE]`](#adr-tool-create-title)
Expand All @@ -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]`

Expand Down Expand Up @@ -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`

Expand All @@ -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)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion templates/toc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Architectural Decision Log

This log lists the architectural decisions for {project}.
This log lists the architectural decisions for this project.

<!-- toc -->

Expand Down

0 comments on commit 35175e1

Please sign in to comment.