docs: Added changelog & readme

This commit is contained in:
Etienne Dx 2021-09-08 22:32:52 +02:00
parent 3aebd137a5
commit bb71f58f81
2 changed files with 34 additions and 0 deletions

15
CHANGELOG.md Normal file
View File

@ -0,0 +1,15 @@
# Changelog
## 1.3.0 - Unreleased
### Added
* Readme and changelog files
* Error messages to *messages.yml*
* List messages to *messages.yml*
### Modified
* Changed java version to java 16
* Changed spigot version to 1.17.1
### Fixed
* Sign header color formatting being lost on server restart

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# RealEstate
RealEstate is a spigot plugin built on top of GriefPrevention to provide players with an ability to sell, rent and lease claims to other players.
The plugin is documented in the [GitHub wiki](https://github.com/EtienneDx/RealEstate/wiki).
Please feel free to report any issue in the [GitHub Issue section](https://github.com/EtienneDx/RealEstate/issues).
## GriefPrevention
This plugin is dependent on GriefPrevention, which since version 1.3.0 will be included directly within the `RealEstate.jar` file.
The original GriefPrevention plugin can be found [here](https://github.com/TechFortress/GriefPrevention). To make RealEstate possible, I had to implement some modifications to GriefPrevention, which I did in this [fork](https://github.com/EtienneDx/GriefPrevention).
<details>
<summary>Code ownership disclaimer</summary>
**I AM NOT THE AUTHOR OF *GriefPrevention*, I MERELY MADE A FEW MODIFICATIONS TO IT. I DO NOT CLAIM ANY PROPERTY OVER THE *GriefPrevention* CODE.**
</details>