milarin/format
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

improved README

Browse Source
This commit is contained in:
Timon Ringwald 2022-04-18 20:21:17 +02:00
parent 6121dbe0eb
commit d733246517
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -8,7 +8,7 @@ The input pattern describes the format in which the lines are parsed from stdin.
This pattern is a regular expression according to [Go's regexp spec](https://pkg.go.dev/regexp). This pattern is a regular expression according to [Go's regexp spec](https://pkg.go.dev/regexp).
Be default, the input pattern will only be applied to every single line. Be default, the input pattern will only be applied to every single line.
When using multiline patterns, you can provide a given amount of lines using the command line argument `-n` followed by an integer amount of lines. When using multiline patterns, you can provide an amount of lines using the command line argument `-n` followed by an integer amount of lines.
Use subgroups for extracting specific parts of the input line. Use subgroups for extracting specific parts of the input line.
@ -45,7 +45,7 @@ Currently only `%s`, `%d` and `%f` are supported though.
Mutators are a simple way of manipulating number values like integers and floats using a simple math-like expression Mutators are a simple way of manipulating number values like integers and floats using a simple math-like expression
You can provide a mutator using the given syntax: `{1:%d:+1}`. It will parse the first capturing group into an integer, adds 1 and then formats the result using the given printf format `%d`. You can provide a mutator using the syntax: `{1:%d:+1}`. It will parse the first capturing group into an integer, adds 1 and then formats the result using the printf format `%d`.
A mutator always consists of an operator and a value. In the example above `+` is the operator and `1` is the value. A mutator always consists of an operator and a value. In the example above `+` is the operator and `1` is the value.