Skip to content

Commit

Permalink
Merge pull request #4 from mschmidtkorth/develop
Browse files Browse the repository at this point in the history 
Updated readme headings
  • Loading branch information
@mschmidtkorth
mschmidtkorth authored Feb 4, 2020
2 parents 875bb76 + 1ceb9a4 commit 228d70d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,24 @@ Before being able to connect to ClickUp, certain parameters need to be configure

The following parameters are *required*:

| Configuration setting | Notation | Example |
| Configuration setting | Description | Example |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| **ClickUp API key** | API token generated in ClickUp (either a public token or a private SSO token). Allows us to connect to your ClickUp account.<br>Can be retrieved from *ClickUp app > Profile Icon (bottom left) > Apps > Generate API key*<br> *Note:* Treat this key as your password. It will be stored in the MacOS Keychain. | `pk_12345_sdhu2348...` |
| **Id for ClickUp Workspace** | Id of the Workspace your tasks reside in. | `2181159` |
| **Id for ClickUp Space** | Id of the Space that defines your available Labels and Priorities. | `2288348` |
| **Id for default ClickUp List** | Id of the List you want new tasks to be added to by default. | `4696187` |
| **Default Tag** | Name of the tag you want to attach to all new tasks (this is only required for the `cul` command). | `to_review` |
| *ClickUp API key* | API token generated in ClickUp (either a public token or a private SSO token). Allows us to connect to your ClickUp account.<br>Can be retrieved from *ClickUp app > Profile Icon (bottom left) > Apps > Generate API key*<br> *Note:* Treat this key as your password. It will be stored in the MacOS Keychain. | `pk_12345_sdhu2348...` |
| *Id for ClickUp Workspace* | Id of the Workspace your tasks reside in. | `2181159` |
| *Id for ClickUp Space* | Id of the Space that defines your available Labels and Priorities. | `2288348` |
| *Id for default ClickUp List* | Id of the List you want new tasks to be added to by default. | `4696187` |
| *Default Tag* | Name of the tag you want to attach to all new tasks (this is only required for the `cul` command). | `to_review` |

*Note:* Your ClickUp user account must be authorized for the specified workspace, space, folder and list.

The following parameters are *optional*:

| Configuration setting | Notation | Example |
| Configuration setting | Description | Example |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| **Id for ClickUp Folder** | Id of the Folder your List is part of. | `2844542` |
| **Default Due Date** | If no Due date is specified when creating a task (via `@`), this Due date is used. | `h2` |
| **Hierarchy Levels to limit Search Results** | When searching (`cus`, `cul`) you can limit the tasks returned by Space, Folder, List or a combination of those. For example, limiting by `space,folder` would use the *Id for ClickUp Space* and *Id for ClickUp Folder* to limit the search results by. If you do not provide a value, all tasks for your Workspace will be returned. | `folder,list` |
| **Show Notification** | Whether to show a notification after creating a task. | `true` |
| *Id for ClickUp Folder* | Id of the Folder your List is part of. | `2844542` |
| *Default Due Date* | If no Due date is specified when creating a task (via `@`), this Due date is used. | `h2` |
| *Hierarchy Levels to limit Search Results* | When searching (`cus`, `cul`) you can limit the tasks returned by Space, Folder, List or a combination of those. For example, limiting by `space,folder` would use the *Id for ClickUp Space* and *Id for ClickUp Folder* to limit the search results by. If you do not provide a value, all tasks for your Workspace will be returned. | `folder,list` |
| *Show Notification* | Whether to show a notification after creating a task. | `true` |

You can validate all parameters via `cu:config validate`. This should be your first step if anything does not work.

Expand Down

0 comments on commit 228d70d

Please sign in to comment.