Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
evanthegrayt committed Jun 18, 2020
1 parent 4a3cd99 commit 443aa64
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,14 @@ StandupMD.configure do |c|
end
```

Any options not set in this file will retain their default values. Note that if
you change `file_name_format`, and don't use a month or year, there will only
ever be one standup file. This could cause issues long-term, as the files will
get large over time and possibly cause performance issues.


#### Executable Flags
Some of these options can be changed at runtime. They are as follows.
```
--current ARRAY List of current entry's tasks
--previous ARRAY List of precious entry's tasks
Expand All @@ -233,11 +240,6 @@ end
DATE must be in the same format as file-name-format
```

Any options not set in this file will retain their default values. Note that if
you change `file_name_format`, and don't use a month or year, there will only
ever be one standup file. This could cause issues long-term, as the files will
get large over time and possibly cause performance issues.

#### Using Existing Standup Files
If you already have a directory of existing standup files, you can use them, but
they must be in a format that the parser can understand. The default is:
Expand Down

0 comments on commit 443aa64

Please sign in to comment.