Update README

README.md

@@ -1,41 +1,30 @@
 # things-3-report
-A small script to generate bulleted reports from my Things 3 tasks
+A small program written in rust that digests my Things tasks into a format for Slack reporting.
 
-## Usage
+Tasks are pulled out of Things using AppleScript over a JavaScript OSA Bridge. Tasks are then filtered
-The environment should be provided by `nix-shell`. Alternatively you can install the requirements directly with
+and formatted based on the selected format schema.
-```bash
-$ pip install -r requirements.txt
-```
-To run the script, pass in the tag or list of tags to filter on. Projects and Tasks lacking one of the specified tags will be excluded from the generated report. I have a `Report` tag which I use for this. If a project is tagged with the tag, all tasks are considered tagged even if not explicitly done so.
 
-### Specific functionality
+## Basic Task format
-I have also included a few pieces of additional functionality:
+A task is returned as a markdown list element containing its title and optionally a list of information parsed from
-- The project is headed with a set of 3 randomly selected emojis from `emojis.txt`
+related tag sections in the notes portion of the task.
-- If you have a person's name in the task or project title, you can add an `@<Persons Name>` tag to the task or project and the script will automatically replace the vowels in their name with unicode that looks similar. This allows you to post the list on slack without generating mentions.
-- Adding a code block that begins with `report` will cause the script to dump the contents into the end of the generated message. This can be used to add notes to the generated output.
-- Be default the script draws from today's current list of tasks. If you specify `--signoff` it will instead draw on completed tasks from your logbook. (This is useful for an end of the day message).
 
-## Example Usage:
+Tag specific additional bullets are included using a triple backtick (like GitHub code block markdown). Then instead of
-Given a set of tasks tagged `Report`
+specifying the coding style as you would (for example `typescript`) you specify the relevant tag: `MyTag`. Running the
-```txt
+program with a given `--tags` argument will cause related tag blocks to be included as sub-bullets.
-Project named "Some Project" tagged as Report:
-  containing two tasks (not necessarily tagged) "Task 1" and "Task 2"
 
-A top level task called some task with a notes filed containing
+## Name Sanitization
-```report
+Name tags found on projects and tasks are automatically sanitized by replacing vowel characters with lookalikes. This
-(#9999)[https://example.com]
+behavior can be disabled with the `--no-sanitize` argument.
-`` ` <-- No space there but it's hard to escape these ticks
-```
 
-```
+## Project Formatting
-$ python dump.py Report
+Projects make up a bullet level above tasks. Any tasks in the project will be nested under the project title following
-```
+and project specific matched tag block comments in the project notes.
-will generate:
 
-```txt
+## Area Formatting
-:emoji: :emoji: :emoji:
+Areas collect up projects, but instead of indenting them further, Area's are returned as section titles above the
-  - Some Project
+generated output. If only one area contains all of the reported tasks, then the area name is omitted entirely.
-    - Task 1
+
-    - Task 2
+## Cycle Message Formatting
-  - Some Task (#9999)(https://example.com)
+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.