Skip to content

Commit

Permalink
add note about editing in-place
Browse files Browse the repository at this point in the history
  • Loading branch information
notslang committed Mar 22, 2016
1 parent 4f6246f commit 3a3fd57
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ Optional arguments:
document.
```

### Editing In-place

If you want to rewrite a file in-place, you can use `sponge` from [moreutils](https://joeyh.name/code/moreutils/). If you did `tidy-markdown < ./README.md > ./README.md` you'd end up with an empty file.

```bash
$ tidy-markdown < ./README.md | sponge ./README.md
```

## API

Tidy Markdown only exports one function. Here's an example of how it can be used:
Expand Down

0 comments on commit 3a3fd57

Please sign in to comment.