cal: basic README added

diff --git a/cal/LICENSE b/cal/LICENSE
index b25517961b845bc7651f3122fddb74f2c6df6567..2c696e9a1a317d1affe81dbdfa4a215a585b578d 100644 (file)
--- a/cal/LICENSE
+++ b/cal/LICENSE
@@ -5,7 +5,7 @@ of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
+furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

diff --git a/cal/README.md b/cal/README.md
new file mode 100644 (file)
index 0000000..ded1b33
--- /dev/null
+++ b/cal/README.md
@@ -0,0 +1,27 @@
+Calendar Export
+===============
+
+This addon makes it possible to export the events posted by your users being
+exported to other formats, so they can be imported into other calendar
+applications.
+
+Exporting a calendar is an _opt-in_ feature which has to be activated by each
+of the users in the _addon settings_. As the admin you can only provide the
+service but should not force it upon your users.
+
+The calendars are exported at
+
+       http://example.com/cal/username/format
+
+currently the only supported format is __ical__.
+
+Author
+------
+
+This addon is developed by [Tobias Diekershoff](https://f.diekershoff.de/profile/tobias).
+
+License
+-------
+
+This addon is licensed under the [MIT](http://opensource.org/licenses/MIT)
+license, see also the LICENSE file in the addon directory.