summaryrefslogtreecommitdiffhomepage
path: root/readme.mdown
diff options
context:
space:
mode:
Diffstat (limited to 'readme.mdown')
-rw-r--r--readme.mdown8
1 files changed, 8 insertions, 0 deletions
diff --git a/readme.mdown b/readme.mdown
new file mode 100644
index 0000000..a5b4195
--- /dev/null
+++ b/readme.mdown
@@ -0,0 +1,8 @@
+# Game Holster
+
+Game holster is a full-stack Ruby on Rails and React application for uploading and serving web games made with common game engines such as Unity, Godot, Raylib, and more.
+
+Currently implemented features in the backend are:
+- User authentication: users can log in using GitHub OAuth
+- Game Upload: Once a user is logged in they can upload a game which will then belong to them
+- Game Serving: Games can be played by users. The games are served under a different domain in order to make XSS attacks impossible in-case a user uploads compromised files.