diff --git a/README.md b/README.md index a080280..203a7c8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,38 @@ SimplyPerms =========== -When powerful plugin made Permissions easy ! \ No newline at end of file +=== ''When powerful plugin made Permissions easy !'' === + +SimplyPerms is yet another Permissions plugin manager based on PermissionsBukkit ideas with the new Configuration API. + +'''WARNING : SimplyPerms is not compatible with PermissionsBukkit or other Permissions plugins, don't forget to disable all this plugins before install this !''' + +''Source code is included in the jar file !'' + +== [http://dev.bukkit.org/server-mods/simplyperms/pages/commands/ Commands] == + +== [http://dev.bukkit.org/server-mods/simplyperms/pages/permissions-and-authorizations/ Permissions and authorizations] == + +== [http://dev.bukkit.org/server-mods/simplyperms/pages/import-from-other-plugins/ Import from other plugins] == + +== Configuration == + +The configuration file is slightly the same than PermissionsBukkit. + +Please refer to the [http://dev.bukkit.org/server-mods/permbukkit/pages/configuration/ PermissionsBukkit documentation]
An example configuration file [http://dev.bukkit.org/server-mods/simplyperms/pages/exemple-of-config-yml/ can be found here]
For the database connection, [http://dev.bukkit.org/server-mods/simplyperms/pages/database-connection/ please refer to this page] + +== Thanks == + +* [http://dev.bukkit.org/server-mods/permbukkit/ PermissionsBukkit] by SpaceManiac for core permissions code +* [http://dev.bukkit.org/server-mods/antiguest/ Antiguest] by QuickWango for part of authorizations feature + +== Todo == + +* Document the database mecanism and setup +* Import form PermissionsBukkit +* Import from other Permissions Plugins +* '''Feel free to ask me new features, improuvements or bugs :D''' + +== Donations == + +I make my plugins with my free time and for free, if you like my work, you can buy me a coffee :D