From 695bf0fbeeab874a1870e9590757ba73cb5b29e4 Mon Sep 17 00:00:00 2001 From: dvelo <52332868+DeveloLongScript@users.noreply.github.com> Date: Wed, 12 Mar 2025 22:45:44 -0500 Subject: [PATCH] chore(readme): revamp readme --- README.md | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 7338dc3..33b842b 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,21 @@ -
-

MHSF

+# ![MHSF Cover](/.github/github-banner.png)
nextjs docs mhsf.app
+## The MHSF Project -An open-source customizable server-list for Minehut built in React. Check it out at [mhsf.app](https://mhsf.app), and maybe give this repo a star! +A modern, third-party server list that is completely open-source, built using top of the line web technologies. Not built to take your money or time, find a server in minutes. Completely ad-free. -## Info - -![Alt](https://repobeats.axiom.co/api/embed/0ee8fb5584604adac02f04cff49f1091af45c3a8.svg "Repobeats analytics image") - -## Tech-stack - -[React](https://react.dev): Component based syntaxing for the web
-[Next.js](https://nextjs.org): Handles API, server-based metadata, and so much more.
-[Clerk](https://clerk.com): Authentication for MHSF (very cool library)
-[TailwindCSS](https://tailwindcss.com): Styling without CSS, simplified
-[shadcn/ui](https://ui.shadcn.com): Provides the awesome UI for MHSF
-And many other smaller libraries are in use to make sure MHSF is feature-packed.
+## Security +Please privately disclose any security problems with a support email or via GitHub (`Security` tab -> `Report a vulnerability`). ## Contributing -> [!NOTE] -> Do you use Java and not JavaScript/TypeScript? You can also contribute to [MHSFPV (Minehut Server List Player Validator)](https://github.com/DeveloLongScript/MHSFPV), a player validator plugin to link accounts. It's relatively small, but can use commits. +Thank you for taking your time to contribute! +Please make sure you read this guide [here](https://github.com/DeveloLongScript/MHSF/blob/main/CONTRIBUTING.md). -The contributing guide is [here](https://github.com/DeveloLongScript/MHSF/blob/main/CONTRIBUTING.md). +## Support +Make a GitHub issue or contact via email, [`support@mhsf.app`](mailto:support@mhsf.app). ## Licensing