Skip to content

Commit

Permalink
Add LICENSE badge & info to README
Browse files Browse the repository at this point in the history
Add a shields.io badge linking to the license file as well as add a
section to the README linking to the license.
  • Loading branch information
dyson committed Oct 26, 2022
1 parent ac8e52e commit 8f8444a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
![version](https://img.shields.io/github/v/tag/dyson/pipesore?label=version)
[![test coverage](https://coveralls.io/repos/github/dyson/pipesore/badge.svg?branch=main)](https://coverallsio/github/dyson/pipesore?branch=main)
[![build workflow](https://github.com/dyson/pipesore/actions/workflows/build.yml/badge.svg)](https://github.com/dyson/pipesore/actions/workflows/build.yml)
[![license](https://img.shields.io/github/license/dyson/pipesore.svg)](https://github.com/dyson/pipesore/blob/master/LICENSE)

*Pipe* because it's similar to unix like pipes and *sore* because the initial
hackathon version of this project was an eyesore.
Expand Down Expand Up @@ -79,3 +80,5 @@ first line of the input and return all other lines.
| Replace(old *string*, replace *string*) | Replaces all non-overlapping instances of `old` with `replace`. |
| ReplaceRegex(regex *string*, replace *string*) | Replaces all matches of the compiled regular expression `regex` with `replace`. Inside `replace`, `$` signs represent submatches. For example `$1` represents the text of the first submatch. |

## License
See [LICENSE](https://github.com/dyson/pipesore/blob/master/LICENSE) file.

0 comments on commit 8f8444a

Please sign in to comment.