diff --git a/README.md b/README.md index 3b484ce..a29b9fb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ +

MHSF

-An open-source Minehut server viewer/finder made in React + Next.js. Is much better than the Minehut one, as has many filters and is improving everyday. +An open-source customizable server-list for Minehut built in React. Check it out at [list.mlnehut.com](https://list.mlnehut.com), and maybe give this repo a star! :) + +> [!WARNING] +> If you want more of a explanation what this is, please use the built-in info popover. This README is mostly for contributing. Thanks! ## Tech-stack @@ -12,6 +16,8 @@ An open-source Minehut server viewer/finder made in React + Next.js. Is much bet And many other smaller libraries are in use to make sure MHSF is feature-packed.
## 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. If you'd like to contribute, you must follow the guidelines below: @@ -29,9 +35,15 @@ First, you must supply the following services with API keys: - MongoDB: Create a database, can be anywhere, and put the location to connect in `.env.local` for the key `MONGO_DB` (this isn't required by any means, but if you want to store any short term or historical data, use this.) - Inngest: Inngest is a smaller library, but runs the `cron` jobs which will make servers automaticly get added to the database. -_This project uses `yarn` as the main package manager. If `package-lock.json` is present, your pull request will get denied._ +> [!IMPORTANT] +> This project uses `yarn` as the main package manager. If `package-lock.json` is present (or any other package manager's lockfile), your pull request will be harder to sort out, please save some work by using `yarn` at the start. + + Second, run `yarn` and `yarn build`. To start the app, run `yarn start`. ### Dev Swap `yarn build` for `yarn dev`. + +## Licensing +MHSF (aka the Minehut Server List) is licensed under the [MIT License](https://github.com/DeveloLongScript/MHSF/blob/main/LICENSE). You are free to fork or modify this software _on your own terms_.