dvelo/mhsf-dev
1
0
Fork 0
mirror of https://github.com/DeveloLongScript/MHSF.git synced 2026-05-07 13:54:59 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: adding new way to make your mark

Browse Source
This commit is contained in:
dvelo 2024-08-12 12:47:20 -05:00
parent e30771206e
commit ae6e27049f
3 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,6 +7,7 @@ An open-source customizable server-list for Minehut built in React. Check it out
> If you want more of a explanation what this is, please use the built-in info popover. This README is mostly for contributing. Thanks!
## Info
![Alt](https://repobeats.axiom.co/api/embed/0ee8fb5584604adac02f04cff49f1091af45c3a8.svg "Repobeats analytics image")
## Tech-stack
@ -19,6 +20,7 @@ An open-source customizable server-list for Minehut built in React. Check it out
And many other smaller libraries are in use to make sure MHSF is feature-packed.<br/>
## 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.
@ -41,12 +43,24 @@ First, you must supply the following services with API keys:
> [!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`.
### Make your mark
If you'd like, you can add a 88x31 badge image to the end of the changelog, which can link to a website of your choice as long as the image and the website are PG13.
Add your image to `/public/imgs` and name it one up from the highest badge so for example, if the badge thats the highest is `badge2.png`, name yours `badge3.png`. Here is a code example of how to add your badge.
In `/src/version.tsx`:
```tsx
<Link href="<your website>">
<Image src="/imgs/badge3.png" alt="<your username>" width={88} height={31} />
</Link>
```
## 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_.

BIN
public/imgs/badge1.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 739 B

After

Width:  |  Height:  |  Size: 1.2 KiB

7
src/version.tsx
View File

@ -114,7 +114,7 @@ export const Changelog = () => (
<br />
<div>
<strong className="flex items-center">
Version b-0.3 (July 23rd 2024):
Version b-0.3 (July 23th 2024):
</strong>
<ul>
<li>
@ -125,14 +125,15 @@ export const Changelog = () => (
<br />
<div>
<strong className="flex items-center">
Version b-0.2 (July 23rd 2024):
Version b-0.2 (July 23th 2024):
</strong>
<ul>
<li>• Inital release!</li>
</ul>
</div>
<br />
<div className="w-full justify-center">
<div>
<strong>All developers that helped out:</strong>
<Link href="https://dvelo.vercel.app">
<Image src="/imgs/badge1.png" alt="cool badge" width={88} height={31} />
</Link>