Skip to content

Commit c67e830

Browse files
author
Nate Fisher
committed
Doc update
1 parent 4e4923e commit c67e830

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Readme.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# smlr
22
Truncates stdin to a maximum fixed size, abbreviating the output if over the specified length.
33

4-
**USAGE**
4+
#### Usage
55
`[source] | smlr [-s SIZE] [-a ALIGNMENT]`
66
* `-s`: Size of output. If equal or greater than input, input is relayed to s unchanged"). Default value is 5.
77
* `-a`: Alignment of output. Can be either `left` or `right`. Default value is middle.
88

9-
**EXAMPLES**
9+
#### Examples
1010
Bring your git branch down to a fixed-size
1111
```
1212
> git rev-parse --abbrev-ref HEAD | smlr -s 10
@@ -27,3 +27,6 @@ Repeat the string if it turns out to be equal, or smaller than, the size given
2727
> echo "abc" | smlr -s 5
2828
> abc
2929
```
30+
31+
#### Installation
32+
Just run a `make` to build it. If everything works out, you'll have a binary in `build/rel/smlr`. Symlink or copy that sucker to a path directory, such as `/usr/bin`.

0 commit comments

Comments
 (0)