Skip to content

Commit

Permalink
Update READMe.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Despical committed Sep 21, 2024
1 parent 260f365 commit e6dc35f
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
[![](https://github.com/Despical/CommandFramework/actions/workflows/build.yml/badge.svg)](https://github.com/Despical/CommandFramework/actions/workflows/build-commandframework.yml)
[![](https://img.shields.io/github/v/release/Despical/CommandFramework)](https://github.com/Despical/CommandFramework/releases/latest)
[![](https://jitpack.io/v/Despical/CommandFramework.svg)](https://jitpack.io/#Despical/CommandFramework)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](../LICENSE)
[![](https://img.shields.io/badge/JavaDocs-latest-lime.svg)](https://javadoc.jitpack.io/com/github/Despical/CommandFramework/latest/javadoc/index.html)
[![](https://img.shields.io/badge/License-GPLv3-blue.svg)](../LICENSE)
[![](https://img.shields.io/badge/javadoc-latest-lime.svg)](https://javadoc.jitpack.io/com/github/Despical/CommandFramework/latest/javadoc/index.html)

This framework is very lightweight annotation based command system that works similar to Bukkit's event system. It removes the necessity to
add commands to your plugin.yml but will still allow you to set command usage, description, permission, aliases, sender type, cooldown, minimum
Expand All @@ -18,10 +18,6 @@ and maximum argument length through the code and adds a bunch of new methods to
- [Wiki](https://github.com/Despical/CommandFramework/wiki)
- [JavaDocs](https://javadoc.jitpack.io/com/github/Despical/CommandFramework/latest/javadoc/index.html)

## Donations
- [Patreon](https://www.patreon.com/despical)
- [Buy Me A Coffee](https://www.buymeacoffee.com/despical)

## Using Command Framework
The project isn't in the Central Repository yet, so specifying a repository is needed.<br>
To add this project as a dependency to your project, add the following to your pom.xml:
Expand Down Expand Up @@ -193,11 +189,6 @@ public class ExampleClass extends JavaPlugin {
}
```

## License
This code is under [GPL-3.0 License](http://www.gnu.org/licenses/gpl-3.0.html)

See the [LICENSE](https://github.com/Despical/CommandFramework/blob/main/LICENSE) file for required notices and attributions.

## Contributing

I accept Pull Requests via GitHub. There are some guidelines which will make applying PRs easier for me:
Expand All @@ -208,6 +199,11 @@ I accept Pull Requests via GitHub. There are some guidelines which will make app

You can learn more about contributing via GitHub in [contribution guidelines](../CONTRIBUTING.md).

## License
This code is under the [GPL-3.0 License](http://www.gnu.org/licenses/gpl-3.0.html).

See the [LICENSE](../LICENSE) file for required notices and attributions.

## Known issues
* ~~Cooldowns are not working command based.~~
* ~~Framework can't detect the sub commands when a sub command registered with the name of main command.~~
Expand Down

0 comments on commit e6dc35f

Please sign in to comment.