Update README.md

This commit is contained in:
MathMan05 2024-07-24 15:55:56 -05:00 committed by GitHub
parent 48f0546b47
commit cbd6b35332
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,19 +1,18 @@
# Jank Client # Jank Client
Jank Client is a [Spacebar](https://spacebar.chat) Client written in TS, HTML, and CSS. Jank Client is a [Spacebar](https://spacebar.chat) Client written in TS, HTML, and CSS.
To run it, clone the repo and do `npm install express`, then either To run it, clone the repo and do `npm install`, then
`node index.js` `node index.js`
or or do the equivalent with bun
`bun index.js`
Both [Bun](https://bun.sh) and [Node.js](https://nodejs.org) are supported, and should function as expected. Both [Bun](https://bun.sh) and [Node.js](https://nodejs.org) are supported, and should function as expected.
To access Jank Client after starting, simply go to http://localhost:8080/login and either register a new account, or log in with your email and password. To access Jank Client after starting, simply go to http://localhost:8080/login and either register a new account, or log in with your email and password.
I'm new to Git/GitHub, so please be patient with me, it's my first time. If there's anything about this repo that's incorrect, please add an issue telling me what it is, or make a merge fixing it. If there are any issues please report them either here, or to me dirrectly on spacebar
## RoadMap
If there are any problems with Jank Client, please let me know.
You can view the current roadmap on https://github.com/users/MathMan05/projects/1. You can view the current roadmap on https://github.com/users/MathMan05/projects/1.
And you can also join the spacebar server for Jank Client here https://dev.app.spacebar.chat/invite/USgYJo ## Link
The official SpaceBar server for Jank Client https://dev.app.spacebar.chat/invite/USgYJo
The current hosted instance of JankClient https://sb-jankclient.vanillaminigames.net