summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Schiewe <git@tforge.de>2018-04-30 19:33:24 +0200
committerTim Schiewe <git@tforge.de>2018-04-30 19:33:24 +0200
commit127cca8835fc1312daf7308720612d535d6df559 (patch)
treefb94549dcf34efd511a48daaecca6d668b5ae3ea
parentf8780560185eae88a4c57f59bb50f7ab60f019d7 (diff)
downloadsplus-127cca8835fc1312daf7308720612d535d6df559.tar.gz
splus-127cca8835fc1312daf7308720612d535d6df559.zip
Update README.md
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 054a570..cf9e8e6 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,20 @@
# SPlus Parser
+The [Ostfalia SPlus lecture schedule](http://splus.ostfalia.de) is complicated to use, due to the lacking responsiveness especially on smartphones. However there are some really good and easy to use calendar programs/apps. This project serves as a bridge between SPlus and those programs.
+
## Setup
+### General
+
+Run `npm install` to install the necessary dependencies.
+
### Google
Follow the steps provided by Google: https://developers.google.com/calendar/auth#OAuth2Authorizing
+You will receive a `client_secret.json` file which contains your Google API credentials. Save this file as ´etc/google/client_secret.json`.
-Then run `npm start` in a terminal, visit the printed link and paste the code that will be provided there into the terminal window.
+Adjust `config.ts` so that it uses the `sinks/GoogleCalendarSink`. Then run `npm start` in a terminal, visit the printed link and paste the code that will be provided there into the terminal window.
### ICS
-Run with ICS as command line argument: `npm start ics`. commit & it will be on [github pages](https://schneefux.github.io/splus/informatik1.ics).
+Adjust `config.ts` so that it uses the `sinks/IcalSink`. Run `npm start` to generate the calendar file.