From 8ec0664fe7cf4a34bc5fc1f162c053622a42dd41 Mon Sep 17 00:00:00 2001 From: realtradam Date: Mon, 24 Jun 2024 00:14:03 -0400 Subject: update readme --- README.md | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7db80e4..85de49a 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,10 @@ -# README +# Game Holster -This README would normally document whatever steps are necessary to get the -application up and running. +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. -Things you may want to cover: +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. -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +The front-end is temporarily my [personal website](https://malcz.com/games) which is made using React. However I am working on a new React frontend in order to have this application be completely standalone and more accessible. -- cgit v1.2.3