Compare commits
No commits in common. "main" and "v2.0.0" have entirely different histories.
1 changed files with 5 additions and 13 deletions
18
README.md
18
README.md
|
|
@ -4,9 +4,6 @@ A small program written in rust that digests my Things tasks into a format for S
|
||||||
Tasks are pulled out of Things using AppleScript over a JavaScript OSA Bridge. Tasks are then filtered
|
Tasks are pulled out of Things using AppleScript over a JavaScript OSA Bridge. Tasks are then filtered
|
||||||
and formatted based on the selected format schema.
|
and formatted based on the selected format schema.
|
||||||
|
|
||||||
## Options
|
|
||||||
See `day-reporter -h` for a current list of options
|
|
||||||
|
|
||||||
## Basic Task format
|
## Basic Task format
|
||||||
A task is returned as a markdown list element containing its title and optionally a list of information parsed from
|
A task is returned as a markdown list element containing its title and optionally a list of information parsed from
|
||||||
related tag sections in the notes portion of the task.
|
related tag sections in the notes portion of the task.
|
||||||
|
|
@ -15,16 +12,6 @@ Tag specific additional bullets are included using a triple backtick (like GitHu
|
||||||
specifying the coding style as you would (for example `typescript`) you specify the relevant tag: `MyTag`. Running the
|
specifying the coding style as you would (for example `typescript`) you specify the relevant tag: `MyTag`. Running the
|
||||||
program with a given `--tags` argument will cause related tag blocks to be included as sub-bullets.
|
program with a given `--tags` argument will cause related tag blocks to be included as sub-bullets.
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
```MyTag
|
|
||||||
Some notes
|
|
||||||
```
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
will result in "Some notes" being included with the task
|
|
||||||
|
|
||||||
## Name Sanitization
|
## Name Sanitization
|
||||||
Name tags found on projects and tasks are automatically sanitized by replacing vowel characters with lookalikes. This
|
Name tags found on projects and tasks are automatically sanitized by replacing vowel characters with lookalikes. This
|
||||||
behavior can be disabled with the `--no-sanitize` argument.
|
behavior can be disabled with the `--no-sanitize` argument.
|
||||||
|
|
@ -36,3 +23,8 @@ and project specific matched tag block comments in the project notes.
|
||||||
## Area Formatting
|
## Area Formatting
|
||||||
Areas collect up projects, but instead of indenting them further, Area's are returned as section titles above the
|
Areas collect up projects, but instead of indenting them further, Area's are returned as section titles above the
|
||||||
generated output. If only one area contains all of the reported tasks, then the area name is omitted entirely.
|
generated output. If only one area contains all of the reported tasks, then the area name is omitted entirely.
|
||||||
|
|
||||||
|
## Cycle Message Formatting
|
||||||
|
The `--mode cycle` argument will output slightly different content. All tasks are collected at a project level, and
|
||||||
|
only the project name is given. Cycle messages look back in time at the last 6 weeks and therefore have too many values
|
||||||
|
to meaningfully output at full resolution.
|
||||||
|
|
|
||||||
Reference in a new issue