Skip to content

Commit

Permalink
Update README to match latest TOML change
Browse files Browse the repository at this point in the history
  • Loading branch information
eripa committed May 27, 2016
1 parent 8099540 commit b327fb6
Showing 1 changed file with 20 additions and 26 deletions.
46 changes: 20 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Basic Auth Checker

Tool to verify Basic Auth status of multiple given endpoints, via JSON configuration file.
Tool to verify Basic Auth status of multiple given endpoints, via TOML configuration file.

## Usage


go get github.com/eripa/ba_checker
cp config-example.json config.json
cp config-example.toml config.toml

# Edit config.json to your liking
ba_checker --config config.json
# Edit config.toml to your liking
ba_checker --no-spinner config.toml


If any check results in `false` in the success column, the tool will exit with 1.
Expand All @@ -34,29 +34,23 @@ If any check results in `false` in the success column, the tool will exit with 1

Same as used in `go test` test cases

```json
{
"sites": [
{
"base": "http://test.webdav.org",
"endpoints": {
"auth-basic": true,
"dav": false,
"": false
}
},
{
"base": "https://httpbin.org/",
"endpoints": {
"basic-auth/:user/:passwd ": true,
"html": false,
"": false
}
}
]
}
```toml
[[site]]
base = "https://httpbin.org"
auth = ["basic-auth/:user/:passwd"]
no_auth = ["html", ""]

[[site]]
base = "http://test.webdav.org"
auth = [
"auth-basic"
]
no_auth = [
"dav",
""
]
```

# License

See LICENSE file
MIT license, see LICENSE file for full details

0 comments on commit b327fb6

Please sign in to comment.