Skip to content

Commit

Permalink
Merge e96840b into a83dfcd
Browse files Browse the repository at this point in the history
  • Loading branch information
denysdovhan committed Nov 13, 2015
2 parents a83dfcd + e96840b commit b170a7b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 66 deletions.
31 changes: 30 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ own ideal text transformer.
npm install --save textr
```


## Usage

```js
Expand All @@ -53,6 +52,36 @@ tf = textr({ locale: 'ru'})
tf('Hello "world"...\n'); // Hello «world»…
```

## CLI

Also, there is a [CLI package][cli] for running Textr under your terminal. You can install it typing:

```
npm install --global textr-cli
```

After installation, you can process files using `textr`-command, like this:

```sh
# load from file, transformers required through few -t flags
$ textr foo.md -t typographic-quotes -t typographic-quotes

# load from file, transformers required through one -t
$ textr foo.md -t typographic-single-spaces,typographic-quotes

# load through stdin, iso-locale equals ru, transformers using --transforms
$ cat foo.md | textr -l ru --transforms=typographic-single-spaces

# load through stdin, write result into file
$ cat foo.md | textr -o bar.md
```

Take a look for more [usage examples][examples] and [CLI options][options].

[cli]: https://github.com/denysdovhan/textr-cli
[examples]: https://github.com/denysdovhan/textr-cli#usage
[options]: https://github.com/denysdovhan/textr-cli#options

## API

### textr(defaults)
Expand Down
65 changes: 0 additions & 65 deletions test/bench.js

This file was deleted.

0 comments on commit b170a7b

Please sign in to comment.