aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIRONM00N <64110067+IRONM00N@users.noreply.github.com>2022-06-11 15:16:43 -0400
committerGitHub <noreply@github.com>2022-06-11 15:16:43 -0400
commit63c8be57bf124fd5470b759abdf90d4db0c44b5f (patch)
tree67ccf040383e4ffb7d8381e95d1948fe1900340d /README.md
parentcc1464047598806f73dd4633ce19e8d22dbfc52b (diff)
downloadNotEnoughUpdates-63c8be57bf124fd5470b759abdf90d4db0c44b5f.tar.gz
NotEnoughUpdates-63c8be57bf124fd5470b759abdf90d4db0c44b5f.tar.bz2
NotEnoughUpdates-63c8be57bf124fd5470b759abdf90d4db0c44b5f.zip
Add more .github files (#162)
added `CODE_OF_CONDUCT.md`, `SECURITY.md`, and `SUPPORT.md` moved `CONTRIBUTING.md` to .github updated `README.md` added some of my files to `CODEOWNERS`
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 26 insertions, 18 deletions
diff --git a/README.md b/README.md
index 7970a73e..4249abc8 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,17 @@
-<!-- markdownlint-disable-file MD033 -->
-<h1 align="center"> NotEnoughUpdates </h1>
+<!-- markdownlint-disable-file MD001 MD033 -->
+<h1 align="center">NotEnoughUpdates</h1>
-<p align="center">
+<div align="center">
<!-- release -->
- <a href="https://github.com/Moulberry/NotEnoughUpdates-REPO/releases/latest" target="_blank">
+ <a href="https://github.com/Moulberry/NotEnoughUpdates/releases/latest" target="_blank">
<img src="https://img.shields.io/github/v/release/Moulberry/NotEnoughUpdates-REPO?color=informational&include_prereleases&label=release&logo=github&logoColor=white" alt="release">
</a>
- <!-- downloads -->
- <!-- <a href="https://github.com/Moulberry/NotEnoughUpdates/releases" target="_blank">
- <img src="https://img.shields.io/github/downloads/Moulberry/NotEnoughUpdates/total?logo=GitHub&color=informational" alt="downloads">
- </a> -->
<!-- lines -->
<a href="https://github.com/NotEnoughUpdates/NotEnoughUpdates/graphs/code-frequency" target="_blank">
<img src="https://img.shields.io/tokei/lines/github/NotEnoughUpdates/NotEnoughUpdates?label=lines&color=informational&logo=GitHub" alt="lines">
</a>
<!-- license -->
- <a href="https://github.com/NotEnoughUpdates/NotEnoughUpdates/blob/master/COPYING.LESSER" target="_blank">
+ <a href="./COPYING.LESSER" target="_blank">
<img src="https://img.shields.io/github/license/NotEnoughUpdates/NotEnoughUpdates?color=informational" alt="license">
</a>
<!-- contributors -->
@@ -30,15 +26,13 @@
<a href="https://github.com/Moulberry/NotEnoughUpdates/releases" target="_blank">
<img src="https://img.shields.io/github/downloads/Moulberry/NotEnoughUpdates/total?label=downloads&color=informational&logo=GitHub" alt="downloads">
</a>
-</p>
+</div>
NotEnoughUpdates (NEU) is a feature rich 1.8.9 Minecraft forge mod for Hypixel Skyblock.
## Getting Started
-<i>If you want to install NEU for development purposes, see [CONTRIBUTING](CONTRIBUTING.md)</i>
-
-<u>**Installing Forge:**</u>
+#### Installing Forge
1. Run normal Minecraft 1.8.9 and once it reaches the title screen wait about 5 seconds and close it.
2. Install Minecraft **1.8.9** forge from the [forge website](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.8.9.html)
@@ -47,9 +41,9 @@ NotEnoughUpdates (NEU) is a feature rich 1.8.9 Minecraft forge mod for Hypixel S
4. When forge is installed, open the Minecraft launcher, go under the `installations tab`, click `new installation`, select the version release `1.8.9-forge1.8.9-11.15.1.xxxx` (it will usually be all the way towards the bottom).
5. Once you are done, run this new installation that you just created. Once it reaches the title screen, wait about 5 seconds and close it.
-<u>**Installing the NotEnoughUpdates mod:**</u>
+#### Installing the NotEnoughUpdates mod
-1. Download the latest mod [release](https://github.com/Moulberry/NotEnoughUpdates/releases). If it says `this file may harm your computer`, click `allow anyways` as all java files will be flagged by Chrome.
+1. Download the latest mod [release](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO/releases). If it says `this file may harm your computer`, click `allow anyways` as all java files will be flagged by Chrome.
2. Add the NEU mod:
- If you have java installed, double click the file, click `install`
- If not, press the windows key + R; type `%appdata%`; click on the folder called `.minecraft`; click on the folder called `mods` and drag the mods file in here.
@@ -57,11 +51,9 @@ NotEnoughUpdates (NEU) is a feature rich 1.8.9 Minecraft forge mod for Hypixel S
4. Then, hop onto Skyblock and run the command `/api new`. Your api key is automatically filled out and all features should work.
5. Type `/neu`. If you see the NotEnoughUpdates menu, you have done this correctly!
-_If you need further assistance feel free to join the [discord](https://discord.gg/moulberry) and ask for help in [#neu-support](discord://discord.com/channels/516977525906341928/714332750156660756)_
-
## Features
-- An [item list](https://github.com/Moulberry/NotEnoughUpdates-REPO) containing information and recipes about every item in skyblock.
+- An [item list](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO) containing information and recipes about every item in skyblock.
- A dungeons minimap.
- Dungeon loot profit checker.
- Item overlays for Treecapitator, Builder's Wand, Block Zapper, and Bonemerang.
@@ -79,3 +71,19 @@ _If you need further assistance feel free to join the [discord](https://discord.
- Slot Locking
- Fishing Particle customization & alerts.
- And [much, much, more.](https://gist.github.com/jani270/d33e249d40b0333b87ba5c5e70fca398)
+
+## Support
+
+If you need assistance installing or using the mod, feel free to join the [discord](https://discord.gg/moulberry) and ask for help in [#neu-support](discord://discord.com/channels/516977525906341928/714332750156660756)
+
+## Contributing
+
+If you would like to contribute to the project, look at our [contribution guide](CONTRIBUTING.md) for more information how to install NEU for development purposes.
+
+## Security
+
+If you have found a vulnerability, please follow our [security policy](.github/SECURITY.md).
+
+## License
+
+This project is licensed under LGPL-3.0-or-later, see [COPYING](COPYING) and [COPYING.LESSER](COPYING.LESSER) for more details.