Skip to content

Commit

Permalink
Update README to reflect latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Makiah authored Jun 26, 2018
1 parent bf41785 commit 3a40bb6
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Wunderlist Tasks Widget

![Screenshot](/doc/Screenshot.png?raw=true "Screenshot")
<p align="center">
<img src="/doc/Screenshot.png">
</p>

I find it very helpful to see upcoming tasks and events right on my desktop, visible with a trackpad swipe, or by minimizing the current window. Unfortunately, Wunderlist doesn't currently have this functionality, until you use this!

Expand All @@ -19,6 +21,22 @@ If you log in, this app should complete the OAuth flow and close the tab, then d
Note that if you want to ```git clone``` this code, you'll have to also install NPM and run ```npm install``` in /lib/oauthserver and /lib/datadisplay to get the node_modules directories.

## Configurable Features
In /lib/datadisplay/datadisplayer.js, you can change ```var includeLists = []``` to ```var includeLists = ["Some List Name", "Some Other List Name"]```, which will filter the lists which are displayed on your desktop to only those in the array (instead of them all). If the list size is zero, it will display all lists by default.
Use the `customization.json` file if you need to change settings from the default.
```
{
"positioning": {
"left-offset-percentage": 59, // the extent to which your widget will be spaced away from the left side of the screen
"top-offset-percentage": 5, // the extent to which your widget will be spaced away from the top side of the screen
"width-percentage": 32.5, // the width of your image, expressed in a percentage of your screen width
"height-percentage": 90 // the width of your image, expressed in a percentage of your screen height
},
"lists-to-display": [
],
"urgency-filters": {
"display-tasks-without-due-date": true, // whether to display tasks without a due date
"display-tasks-due-within-x-days": 7 // the maximum number of days between now and the task's due date for it to be considered "urgent"
}
}
```

**Disclaimer**: I haven't done a lot to make this code super secure: the Wunderlist access token is obtained by querying the local server, and I also store the token in plain text currently. If you use Wunderlist for secure work stuff then don't use this unless you're certain there's no risk of being hijacked (I'm a student, the worse thing that could happen is someone delete my test reminder, which would take approximately 5 seconds to put back).

0 comments on commit 3a40bb6

Please sign in to comment.