README fixes & a few links

This commit is contained in:
TomatoCake 2024-06-28 05:27:06 +02:00 committed by GitHub
parent 7334ace43c
commit fd4cb4058a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,12 +1,17 @@
# JankClient
JankClient is a SpaceBar Client written in JS, HTML, and CSS.
To run it, clone the repo and do `npm install express`, then either
# Jank Client
Jank Client is a [Spacebar](https://spacebar.chat) Client written in JS, HTML, and CSS.
To run it, clone the repo and do `npm install express`, then either
`node index.js`
or
`bun index.js`
Both bun and node are supported, and should function as expected.
To access Jank Client after init simply go to http://localhost:8080/login and login with your username 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 problems with Jank Client, please let me know.
`bun index.js`
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.
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 problems with Jank Client, please let me know.
You can view the current roadmap on https://github.com/users/MathMan05/projects/1.