Skip to content

Commit

Permalink
docs: correct usage and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jceb committed Dec 29, 2022
1 parent 6d26b1a commit 037d85f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ genreation.

## Usage

If you want to generate a table of contents in your markdown file, Add a heading
called `Contents` before running the script. The table of contents will be added
beneath the heading.

Format a Markdown file:

```bash
deno run --unstable --allow-read --allow-write https://deno.land/x/remark_format_cli/remark-format.js README.md
deno run --unstable --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.0.8/remark-format.js README.md
```

Or with the locally [installed](#install) script:
Expand All @@ -32,7 +36,7 @@ remark-format README.md
## Install

```bash
deno install --unstable --allow-read --allow-write https://deno.land/x/remark_format_cli/remark-format.js
deno install --unstable --allow-read --allow-write https://deno.land/x/remark_format_cli@v0.0.8/remark-format.js
```

Once installed, the local command `remark-format` will be available.
Expand Down

0 comments on commit 037d85f

Please sign in to comment.