|
1 | 1 | # TODOIST-REST-CLIENT |
| 2 | +## v.0.0.3 |
2 | 3 |
|
3 | | -## _A simple todoist-rest-api client_ |
| 4 | +## Working on |
4 | 5 |
|
5 | | -A todoist rest API client with: |
6 | | - |
7 | | -## Implemented Features |
8 | | - |
9 | | -- get Today Tasks |
10 | | -- get All Tasks |
11 | | -- create task (see example) |
12 | | - |
13 | | -I'd implement more features in the future like: |
14 | | - |
15 | | -- new resources |
16 | | -- more tasks functions |
17 | | - |
18 | | -> something important |
19 | | -
|
20 | | -## Installation |
21 | | - |
22 | | -For installing the client: |
23 | | - |
24 | | -```sh |
25 | | -npm install todoist-rest-client |
26 | | -``` |
27 | | - |
28 | | -## USE |
29 | | - |
30 | | -```js |
31 | | -import TDSClient from "todoist-rest-client"; |
32 | | - |
33 | | -const Client = new TDSClient(API_TOKEN); //get an api token from your todoist integrations page |
34 | | -``` |
35 | | - |
36 | | -## API |
37 | | - |
38 | | -### Client.create({type}, todoistResource) |
39 | | - |
40 | | -This method allows creating todoist resources (tasks, projects, ...). |
41 | | -If no params are given, it creates a _No_Content_ task in the inbox. |
42 | | -If given type param, creates default todoistResourceType. |
43 | | - |
44 | | -```js |
45 | | -//Creating a todoist resource |
46 | | -import TDSClient from "todoist-rest-client"; |
47 | | - |
48 | | -const Client = new TDSClient(API_TOKEN); //get an api token from your todoist integrations page |
49 | | - |
50 | | -Client.create({ type: "task" }); |
51 | | -``` |
52 | | - |
53 | | -## Todoist Resources |
54 | | - |
55 | | -Todoist resources are classes that allow you to easyly create resource objects for todoist. |
56 | | -They can be imported directly from the package: |
57 | | - |
58 | | -```js |
59 | | -import {Task} from "todoist-rest-client"; |
60 | | - |
61 | | -const myTask = new Task({....}); |
62 | | -``` |
63 | | - |
64 | | -### Task |
65 | | - |
66 | | -Tasks, are the basic pieces of todoist. Each task has a lot of properties: content, date, priority... |
67 | | - |
68 | | -### Future Implementations |
69 | | - |
70 | | -In future versions of this package, I'd like to implement more resources to work with projects, comments and all the Todoist's stuff. |
| 6 | +- New resources: Projects & Sections !! |
| 7 | +- New general functions: |
| 8 | + - Find by ID |
71 | 9 |
|
72 | 10 | ## License |
73 | 11 |
|
74 | | -MIT |
| 12 | +MIT © [Dubisdev](https://dubis.dev) |
0 commit comments