From acc7b3c841542e9d856c4c2f4307b219b4f8be32 Mon Sep 17 00:00:00 2001 From: pwompus Date: Fri, 28 Jun 2024 09:19:27 +1000 Subject: [PATCH 1/4] Rewrite README.md --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6236e2b..07b8617 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ # JankClient -A SpaceBar Client written in JS HTML and CSS -To run, clone the repo and do `npm install express`, then either +JanKClient is a SpaceBar 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 both should function as expected. If there are any problems with Jank Client, please let me know. To access Jank Client after init simply go to http://localhost:8080/login and login with your username and password. - -Guild with more info and updates: -https://dev.app.spacebar.chat/invite/WOVGtp - -Please report bugs either here or in the guild provided, thank you. - -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 +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. From b952e5a78133e6a1bc1743fb724c7ee3aebe9c89 Mon Sep 17 00:00:00 2001 From: pwompus Date: Fri, 28 Jun 2024 11:29:00 +1000 Subject: [PATCH 2/4] simple fix to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 07b8617..4903397 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # JankClient -JanKClient is a SpaceBar Client written in JS, HTML, and CSS. +JankClient is a SpaceBar Client written in JS, HTML, and CSS. To run it, clone the repo and do `npm install express`, then either `node index.js` or From fd4cb4058a4e02ce83a4cc8b2170b29c84f3150e Mon Sep 17 00:00:00 2001 From: TomatoCake <60300461+DEVTomatoCake@users.noreply.github.com> Date: Fri, 28 Jun 2024 05:27:06 +0200 Subject: [PATCH 3/4] README fixes & a few links --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4903397..44a0961 100644 --- a/README.md +++ b/README.md @@ -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. From cbec9ff06e6c8df212c33d2572360c93dc4af2cd Mon Sep 17 00:00:00 2001 From: MathMan05 <73901602+MathMan05@users.noreply.github.com> Date: Thu, 27 Jun 2024 22:47:59 -0500 Subject: [PATCH 4/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 44a0961..527b2c8 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,5 @@ I'm new to Git/GitHub, so please be patient with me, it's my first time. If ther 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. + +And you can also join the spacebar server for Jank Client here https://dev.app.spacebar.chat/invite/USgYJo