From bae33553597415874af22bc37c7a670f1b8afefd Mon Sep 17 00:00:00 2001 From: Caitlin Elfring Date: Thu, 4 Nov 2021 20:22:42 -0400 Subject: [PATCH] docs: remote config file --- docs/usage.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index da938dd5..642ba963 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -14,6 +14,15 @@ This file will be picked up automatically up your customizations without needing See [example.yaml]({{config.repo_url}}blob/main/example.yaml) for an example of adding custom rules. You can also supply your own rules with `-c path/to/rules.yaml` if you want to handle different rulesets. +### Remote config file + +You can also use a remote config file by providing a publicly-accessible URL. + +```bash +$ woke -c https://raw.githubusercontent.com/get-woke/woke/main/example.yaml +No findings found. +``` + ## Inputs ### File globs