update readme file

QuorumDMS · Apr 14, 2021 · 30a5b3a · 30a5b3a
1 parent 4946327
commit 30a5b3a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -13,16 +13,15 @@ easy CLI for ADR docs
 * [Commands](#commands)
 <!-- tocstop -->
 # Usage
+
+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
-$ npm install -g adr-tool
-$ adr-tool COMMAND
-running command...
-$ adr-tool (-v|--version|version)
-adr-tool/0.0.5 darwin-x64 node-v14.16.0
-$ adr-tool --help [COMMAND]
+$ npx adr-tool init
+./docs/adr folder is created!
 USAGE
-  $ adr-tool COMMAND
+  $ npx adr-tool create 'Use Markdown Architectural Decision Records'
 ...
 ```
 <!-- usagestop -->

diff --git a/src/commands/create.ts b/src/commands/create.ts
@@ -82,9 +82,7 @@ a decision created on ./docs/adr/0001-use-adr-tool.md
 
     const tocFileRaw = fs.readFileSync(tocFilePath, 'utf8')
     const tocFileArray = tocFileRaw.split('\n')
-
     const tocString = `* [ADR-${fileIndex}](${filename}.md) - ${args.title}`
-
     const tocStopIndex = tocFileArray.indexOf('<!-- tocstop -->')
     tocFileArray.splice(tocStopIndex - 1, 0, tocString)