diff --git a/README.md b/README.md index 0d077c7..0dec400 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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