Improve readme file

Link wiki API page, clean compatibility notes a bit, fix formatting.
This commit is contained in:
Alex "mcmonkey" Goodwin 2018-09-21 07:14:25 -07:00 committed by GitHub
parent 1dc0edd7b0
commit 71373fb73e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions

View File

@ -1,14 +1,17 @@
Citizens2 README
================
Citizens is an NPC plugin for the Bukkit API. It was first released on March 5, 2011, and has since seen numerous updates. Citizens provides an API which developers can use to create their own NPC characters. More information on the API can be found at its repository (https://github.com/CitizensDev/CitizensAPI).
Citizens is an NPC plugin for the Bukkit API. It was first released on March 5, 2011, and has since seen numerous updates. Citizens provides an API which developers can use to create their own NPC characters. More information on the API can be found on the API page of the Citizens Wiki (https://wiki.citizensnpcs.co/API).
Compatible with:
* Minecraft (see http://wiki.citizensnpcs.co/Versions for info)
* CitizensAPI
* Minecraft (for specific compatible version information, see http://wiki.citizensnpcs.co/Versions for info)
* CitizensAPI (for compiling purposes only)
Extra information
=================
Javadoc: http://jd.citizensnpcs.co
Spigot page: https://www.spigotmc.org/resources/citizens.13811
For questions/help join our discord at: https://discord.gg/Q6pZGSR