Module: Abt::Docs::Markdown

Defined in:
lib/abt/docs/markdown.rb

Class Method Summary collapse

Class Method Details

.readmeObject



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/abt/docs/markdown.rb', line 7

def readme
  "    # Abt\n\n    Abt makes re-occuring tasks easily accessible from the terminal:\n    - Moving asana tasks around\n    - Tracking work/meetings in harvest\n    - Consistently naming branches\n\n    ## How does abt work?\n\n    Abt is a hybrid of having small scripts each doing one thing:\n    - `start-asana --project-gid xxxx --task-gid yyyy`\n    - `start-harvest --project-id aaaa --task-id bbbb`\n\n    And having a single highly advanced script that does everything with a single command:\n    - `start xxxx/yyyy aaaa/bbbb`\n\n    Abt looks like one command, but works like a bunch of light scripts:\n    - `abt start asana:xxxx/yyyy harvest:aaaa/bbbb`\n\n    ## Usage\n    `abt <command> [<ARI>] [<options> --] [<ARI>] ...`\n\n    Definitions:\n    - `<command>`: Name of command to execute, e.g. `start`, `finalize` etc.\n    - `<ARI>`: A URI-like resource identifier with a scheme and an optional path in the format: `<scheme>[:<path>]`. E.g., `harvest:11111111/22222222`\n    - `<options>`: Optional flags for the command and ARI\n\n    \#{example_commands}\n\n    ## Commands:\n\n    Some commands have `[options]`. Run such a command with `--help` flag to view supported flags, e.g: `abt track harvest -h`\n\n    \#{provider_commands}\n\n    #### This readme was generated with `abt readme > README.md`\n  MD\nend\n"