Skip to content

Commit

Permalink
Update README config file setup
Browse files Browse the repository at this point in the history
  • Loading branch information
botan committed Aug 31, 2023
1 parent 954ba49 commit f9c6922
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f9c6922

Please sign in to comment.