Added README.md
This commit is contained in:
parent
148f148b0d
commit
05de07dfa7
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# pack2task
|
||||
|
||||
Utility scripts for tracking package delivery progress and setting
|
||||
CalDAV reminders to go pick them up!
|
||||
|
||||
## Status
|
||||
|
||||
This is still very much a work-in-progress! But I intend on
|
||||
developping this as much as possible and supporting as many delivery
|
||||
trackers as possible!
|
||||
|
||||
## Usage
|
||||
|
||||
1. Clone the repo
|
||||
2. Create `~/.config/pack2task/config.json`. It should have the following content:
|
||||
```json
|
||||
{
|
||||
"login": "username:password for your CalDAV server",
|
||||
"calendar": "https:// - path to the CalDAV calendar where you want your events to go"
|
||||
}
|
||||
```
|
||||
3. Add a package to track using `pack2task-add.sh <URL to tracker>`
|
||||
4. Periodically run `pack2taskd.sh`. You should run it by hand the first time to make sure it works!
|
||||
|
||||
## Supported trackers
|
||||
|
||||
* MondialRelay (France)
|
Loading…
Reference in a new issue