From a569c455bff4ab5d17dc73cf5d4425daa260fd9d Mon Sep 17 00:00:00 2001
From: Quantum <quantum2048@gmail.com>
Date: Thu, 6 Dec 2018 22:26:11 -0500
Subject: [PATCH] Add README

---
 README.md          | 34 ++++++++++++++++++++++++++++++++++
 src/redirects.conf | 11 +++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3709c3d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# `uwat.cf` [![Jenkins](https://img.shields.io/jenkins/s/https/ci.quantum2.xyz/job/uwat.cf.svg)](https://ci.quantum2.xyz/job/uwat.cf/) [![GitHub](https://img.shields.io/github/license/quantum5/uwat.cf.svg)](LICENSE)
+
+`uwat.cf` is a gateway to various resources related to the University of
+Waterloo, made by Waterloo students for Waterloo students.
+
+We provide shortcut links to make your life easier. Instead of scrambling to
+remember that site where it shows your exam schedule and seating, simply go to
+[uwat.cf/exams][1]. The [homepage][2] is a list of these shortcuts.
+
+## Contributing
+
+Everyone is welcome to contribute! Simply send in a pull request with your
+useful link, and if it passes quality control, it will be merged and made
+available to the public.
+
+To add a link, add the shortcut link and description to the relevant section in
+[`src/index.html`][3]. You can also add new sections if none of the existing
+sections fit the bill.
+
+To add the redirect, add it to [`src/redirects.conf`][4], into the same place
+as you did in `src/index.html`. `redirects.conf` is included inside an
+[nginx `map` block][5], and the syntax is:
+
+```
+/shortcut "https://example.com/long/url";
+```
+
+Thank you for contributing.
+
+  [1]: https://uwat.cf/exams
+  [2]: https://uwat.cf
+  [3]: src/index.html
+  [4]: src/redirects.conf
+  [5]: https://nginx.org/en/docs/http/ngx_http_map_module.html
diff --git a/src/redirects.conf b/src/redirects.conf
index d3ac8c7..94ae168 100644
--- a/src/redirects.conf
+++ b/src/redirects.conf
@@ -1,11 +1,22 @@
+# Example link
 /link "https://uwat.cf/";
+
+# General
 /learn "https://learn.uwaterloo.ca/d2l/home";
 /quest "https://quest.pecs.uwaterloo.ca/psp/SS/ACADEMIC/SA/?cmd=login&languageCd=ENG";
 /watcard "https://watcard.uwaterloo.ca/OneWeb/Account/LogOn";
 /exams "https://odyssey.uwaterloo.ca/teaching/schedule";
+
+# Faculty of Math
 /marmoset "https://marmoset.student.cs.uwaterloo.ca/";
 /mathexams "http://mathsoc.uwaterloo.ca/exambank";
+
+# Faculty of Engineering
 /engexams "https://exams.engsoc.uwaterloo.ca/";
 /engrank "https://engug.uwaterloo.ca/";
+
+# Co-op
 /coopcal "https://uwaterloo.ca/co-operative-education/important-dates";
+
+# Finances
 /endow "https://uwaterloo.ca/forms/finance/user?destination=endowment_request";