From b9f6602c72849c9b2e8abab4a88ab36c5b113e0c Mon Sep 17 00:00:00 2001
From: NK <oscarfu0721@gmail.com>
Date: Tue, 20 Dec 2022 17:39:04 +0000
Subject: [PATCH] README

---
 README | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..3be68c5
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+# NullValkyrie
+
+Welcome to the NullValkyrie repository! This project is designed to be a lightweight and efficient security tool for detecting and mitigating vulnerabilities in web applications.
+
+## Features
+
+- Custom items to use and play
+- Miners to generate money and ores when you are offline
+- Custom enchantments
+- Custom recipes
+- Custom mobs
+- Custom holograms
+- Custom NPCs to do all kind of things
+
+## Getting Started
+
+To get started with NullValkyrie, simply clone the repository and install the dependencies using Maven:
+
+```cmd
+git clone https://github.com/night0721/NullValkyrie.git
+cd NullValkyrie
+```
+If you are using IntelliJ, you can import the project as a Maven project and install the dependencies by clicking button on the right side of the screen.
+
+## Support
+
+If you need support, you can join the Discord server: https://discord.gg/qTfXU3yuuN or DM me on Discord: Ń1ght#4004
+
+## License
+
+NullValkyrie is licensed under the CC-BY-NC-SA-4.0. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information.
+
+## Credits
+
+- [night0721] - Discord: Ń1ght#4004
+
+
+After installing dependencies, you are able to use install/package command to compile the plugin to JAR, or instead, use build artifact.
+Then, you can add the plugin to your plugin folder and start the server to use it.
+
+## Contribution
+
+We welcome contributions to the NullValkyrie project! If you have any ideas for improvements or new features, please feel free to fork the project and create a pull request or open an issue.
+All contributions are welcome, including translations, documentation, and code.
+
+## License
+
+NullValkyrie is licensed under the MIT License. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information.
\ No newline at end of file