Skip to content

Commit e9a230d

Browse files
committed
Flesh out the readme
1 parent 7d7a075 commit e9a230d

File tree

1 file changed

+91
-1
lines changed

1 file changed

+91
-1
lines changed

README.md

+91-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,93 @@
11
# icaltoday
22

3-
A description of this package.
3+
This is a small swift program that can print events
4+
from your various calendars in JSON format. It is
5+
similar to [icalBuddy](https://github.com/ali-rantakari/icalBuddy),
6+
which appears to 1) not be maintained and 2) not provide structured,
7+
machine-readable output.
8+
9+
There are just
10+
two commands. Maybe I'll add more later.
11+
12+
Get a list of your calendars:
13+
14+
```
15+
> icaltoday calendars list
16+
[
17+
"US Holidays",
18+
"MOJ",
19+
"Holidays in United States",
20+
"Consulting",
21+
"Family",
22+
"Work",
23+
"Contacts",
24+
"Kate",
25+
"Birthdays",
26+
]
27+
```
28+
29+
Get a list of events between two dates for two calendars:
30+
```
31+
> icaltoday events list 2022-10-18 2022-10-20 -c MOJ -c Kate
32+
[
33+
{
34+
"attendeeEmails" : [
35+
],
36+
"date" : "2022-10-19T12:00:00Z",
37+
"isToday" : false,
38+
"name" : "Xuff Dude",
39+
"uid" : "[email protected]",
40+
"uidAsBase64" : "NWb3NlaDVRtNmo31ZzBhNDUxa2FibHYxYzRAZ29vZ2xlLmNvbQ=="
41+
},
42+
{
43+
"attendeeEmails" : [
44+
45+
46+
47+
48+
],
49+
"date" : "2022-10-19T14:15:00Z",
50+
"isToday" : false,
51+
"name" : "Startup chat",
52+
"uid" : "040000008200E1000000000000000010000000C00074C5B7101A82E008000000000B73BD888EC1D80EC9B1933E71464DB88DFA7A5289F629",
53+
"uidAsBase64" : "Dc0QzVCNzEwMUE4MkUwMDgwMDAwMDAwMDBCNzNCRDg4OEVDMUQ4MMDQwMDAwMDA4MjAwRTAwMDEwMDAwMDAwMDAwMDAwMDAwMTAwMDAwMDBDRUM5QjE5MzNFNzE0NjREQjg4REZBN0E1Mjg5RjYyOQ=="
54+
}
55+
]
56+
```
57+
58+
## Building
59+
60+
On a mac, run `make` to build a debugging version. Run `make release` to build
61+
a release version.
62+
63+
## Contributing
64+
65+
Please send a pull request!
66+
67+
## License
68+
69+
This is free and unencumbered software released into the public domain.
70+
71+
Anyone is free to copy, modify, publish, use, compile, sell, or
72+
distribute this software, either in source code form or as a compiled
73+
binary, for any purpose, commercial or non-commercial, and by any
74+
means.
75+
76+
In jurisdictions that recognize copyright laws, the author or authors
77+
of this software dedicate any and all copyright interest in the
78+
software to the public domain. We make this dedication for the benefit
79+
of the public at large and to the detriment of our heirs and
80+
successors. We intend this dedication to be an overt act of
81+
relinquishment in perpetuity of all present and future rights to this
82+
software under copyright law.
83+
84+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
85+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
86+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
87+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
88+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
89+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
90+
OTHER DEALINGS IN THE SOFTWARE.
91+
92+
For more information, please refer to <http://unlicense.org/>
93+

0 commit comments

Comments
 (0)