Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #38

Merged
merged 1 commit into from
Jan 23, 2022
Merged

Update README.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,11 @@
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#installation">Installation</a></li>
<li><a href="#installation-with-maven">Installation with Maven</a></li>
<li><a href="#installation-with-gradle">Installation with Gradle</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#plugins-that-use-vcompat">Plugins that use vCompat</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
Expand Down Expand Up @@ -121,14 +122,19 @@ dependencies {
}
```

<!-- USAGE EXAMPLES -->
## Usage

_Comming soon_

_For more examples, please refer to the [Documentation](https://confluence.syntaxphoenix.com/display/VCOMPAT)_
Please use the [vCompatUpdater](https://github.com/SourceWriters/vCompatUpdater) to install vCompat for your plugin.
Shading vCompat is not a good idea which is why we created that updater.
To see how you can implement it for v2 / v3 of vCompat look at our [vCompatExample](https://github.com/SourceWriters/vCompatExample)
or at one of the plugins mentioned in [Plugins that use vCompat](#plugins-that-use-vcompat).

<!-- PLUGINS THAT USE VCOMPAT -->
## Plugins that use vCompat

<ul>
<li><a href="https://www.spigotmc.org/resources/91756/">SkinsEvolved</a></li>
<li><a href="https://www.spigotmc.org/resources/39601/">LoginPlus</a></li>
<li><a href="https://www.spigotmc.org/resources/17573/">JumpLeaguePlus</a></li>
</ul>

<!-- ROADMAP -->
## Roadmap
Expand All @@ -149,7 +155,6 @@ Contributions are what make the open source community such an amazing place to b
5. Open a Pull Request



<!-- LICENSE -->
## License

Expand Down