brok 0.1.2.0 → 0.1.3.0

raw patch · 3 files changed

+29/−1 lines, 3 files

Files

• README.md +10/−0
• brok.cabal +2/−1
• template/usage.txt +17/−0

@@ -12,6 +12,16 @@  [Binaries for Mac and Linux are available](https://github.com/smallhadroncollider/brok/releases). Add the binary to a directory in your path (such as `/usr/local/bin`). +### Cabal++If you have `cabal` installed:++```bash+cabal install brok+```++Make sure you run `cabal update` if you haven't run it recently.+ ### Building  **Requirements**: [Stack](https://docs.haskellstack.org/en/stable/README/)

@@ -1,6 +1,6 @@ cabal-version: 1.12 name: brok-version: 0.1.2.0+version: 0.1.3.0 license: BSD3 license-file: LICENSE copyright: 2019 Small Hadron Collider@@ -15,6 +15,7 @@ build-type: Simple extra-source-files:     README.md+    template/usage.txt  source-repository head     type: git

@@ -0,0 +1,17 @@+Usage: brok [--cache SECONDS] [--interval MILLISECONDS] [--ignore URLS] FILES++Options:++--cache SECONDS           The number of seconds to cache successful results for (default: 86400)+--interval MILLISECONDS   The number of milliseconds between each request (default: 100)+--ignore URLS             A list of URL prefixes to ignore++Examples:++brok links.md+brok links.md links.tex+brok */**/*.tex+brok --cache 604800 links.md links.tex+brok --interval 1000 links.md links.tex+brok --ignore "https://facebook.com" "https://google.com" links.md links.tex+brok --cache 604800 --interval 1000 --ignore "https://facebook.com" "https://google.com" */**/*.tex