aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatt Strapp <matt@mattstrapp.net>2022-02-09 20:10:38 -0600
committerMatt Strapp <matt@mattstrapp.net>2022-02-09 20:10:38 -0600
commit66b243e6955f6ec14acbdebf53350e97e9a84e48 (patch)
tree2a45b2fc3282d68845851da62578bf8313a319df
parentAdd some security stuffs (diff)
downloadee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.tar
ee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.tar.gz
ee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.tar.bz2
ee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.tar.lz
ee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.tar.xz
ee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.tar.zst
ee4511w-web-66b243e6955f6ec14acbdebf53350e97e9a84e48.zip
Add a super basic README
Signed-off-by: Matt Strapp <matt@mattstrapp.net>
-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.**