Skip to content

Commit

Permalink
Merge pull request #38 from SourceWriters/development
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Lauriichan authored Jan 23, 2022
2 parents e4295e8 + 891a7c4 commit 21f3a6d
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
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

0 comments on commit 21f3a6d

Please sign in to comment.