Commit 55948fa8 authored by Nicolas Lenz's avatar Nicolas Lenz
Browse files

Update readme

parent 9d2e8b1e
# mock
# Mock
![wAR miR jEtzT Zu anSTRENgEnd dA JedeN ZWEiten BUChSTaBeN GRoSS zU scHREiBen](mock.png)
## Installation
```
$> stack setup
$> stack install
```
$> stack build
$> stack exec -- mock random This is a great program.
This will install Mock into `~/.local/bin`, which should be added to `$PATH`.
There is also an [AUR package](https://aur.archlinux.org/packages/haskell-mock/) available.
## Usage
`mock [STYLE] [TEXT]`
You can get a list of possible mock styles with `stack exec -- mock`.
If no text is given, input is read from `stdin`.
### Examples
```
$> mock random This is a great program.
ThIs Is A greaT PROgrAM.
$> stack exec -- mock space This is a great program.
$> mock space This is a great program.
T h i s i s a g r e a t p r o g r a m.
```
You can get a list of possible mock styles with `stack exec -- mock`.
Mock calls can be concatenated with pipes:
```
$> mock space This is a great program. | mock random
T h I S i S A G R e A t P R o g r a m .
```
[![WTFPL-Badge](wtfpl.png)](http://www.wtfpl.net)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment