From f9c692216899b530ae3eb3159f56528119868b9a Mon Sep 17 00:00:00 2001 From: botan Date: Thu, 31 Aug 2023 22:15:00 +0100 Subject: [PATCH] Update README config file setup --- README.Rmd | 10 ++++++---- README.md | 9 +++++---- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.Rmd b/README.Rmd index f141358..3cd726d 100644 --- a/README.Rmd +++ b/README.Rmd @@ -86,10 +86,12 @@ The vignettes contain setup instructions and example usage: ### Config File Setup -The `slackr_setup()` function will try to read setup values from a `~/.slackr` -(you can change the default) configuration file, which may be easier and more -secure than passing them in manually (plus, will allow you to have multiple -`slackr` configurations for multiple Slack.com teams). +The `slackr_setup()` function will try to read setup values from a `~/.slackr` +(you can change the default filepath by recording in the SLACKR_CONFIG_FILE +environment variable or supplying as an argument to the `config_file` +parameter) configuration file, which may be easier and more secure than passing +them in manually (plus, will allow you to have multiple `slackr` configurations +for multiple Slack.com teams). The file is in Debian Control File (DCF) format since it really doesn't need to be JSON and R has a handy `read.dcf()` function since that's what `DESCRIPTION` diff --git a/README.md b/README.md index f06beab..08de475 100644 --- a/README.md +++ b/README.md @@ -87,10 +87,11 @@ roughly the same, with only slightly differing scopes. ### Config File Setup The `slackr_setup()` function will try to read setup values from a -`~/.slackr` (you can change the default) configuration file, which may -be easier and more secure than passing them in manually (plus, will -allow you to have multiple `slackr` configurations for multiple -Slack.com teams). +`~/.slackr` (you can change the default filepath by recording in the +SLACKR_CONFIG_FILE environment variable or supplying as an argument to +the `config_file` parameter) configuration file, which may be easier and +more secure than passing them in manually (plus, will allow you to have +multiple `slackr` configurations for multiple Slack.com teams). The file is in Debian Control File (DCF) format since it really doesn’t need to be JSON and R has a handy `read.dcf()` function since that’s