aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7b16317
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# 4951w Pendulum
+
+[![GitHub Actions](https://github.com/RosstheRoss/4951w-pendulum/actions/workflows/node.yml/badge.svg)](https://github.com/RosstheRoss/4951w-pendulum/actions/workflows/node.yml)
+[![Known Vulnerabilities](<https://snyk.io/test/github/RossTheRoss/4951w-pendulum/badge.svg>)](<https://snyk.io/test/github/RossTheRoss/4951w-pendulum>)
+
+An complete rewrite of the web application for Professor Andrew Lamperski's Remotely Accessible Inverted Pendulum, in TypeScript.
+
+## TODO
+
+- Feature parity with the original web application.
+ - This includes running the python scripts like the Flask app did.
+- Login with the University's Shibboleth system.
+- Add the livestreaming feature.
+- **Improve the readme.**