Skip to content

Commit 8be3fec

Browse files
authored
Add client-library waterlink to list (#439)
1 parent 45f8de0 commit 8be3fec

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,19 @@ The public api ("api" in a very broad sense) of Lavalink can be categorized into
4343
- **Server Domain:** The server application with its runtime environment, its configuration, etc.
4444

4545
Changes that might be breaking to one domain need not be breaking to the other.
46-
Examples:
46+
Examples:
4747
- Removing an endpoint. This is a breaking change for the client domain, but is
4848
not a breaking change for running the server itself.
4949
- Upgrading the minimum Java version: This is a breaking change for the server domain,
50-
but client implementations couldn't care less about it.
50+
but client implementations couldn't care less about it.
5151

5252
Given the above, the following versioning pattern lends itself well to the Lavalink project:
5353

5454
_**api.major.minor.patch**_
5555

56-
- **Api**: Bumped when breaking changes are comitted to the client domain of Lavalink
57-
Examples: Removing an endpoint, altering output of an endpoint in a non backwards compatible manner
58-
- **Major**: Bumped when breaking changes are comitted to the Lavalink server domain
56+
- **Api**: Bumped when breaking changes are comitted to the client domain of Lavalink
57+
Examples: Removing an endpoint, altering output of an endpoint in a non backwards compatible manner
58+
- **Major**: Bumped when breaking changes are comitted to the Lavalink server domain
5959
Examples: Bumping the required Java version, altering the configuration in a non backwards compatible manner
6060
- **Minor**: New features in any domain
6161
Examples: New optional endpoint or op code, additional configuration options, change of large subsystems or dependencies
@@ -64,7 +64,7 @@ Examples: Fixing a race condition, fixing unexpected exceptions, fixing output t
6464

6565
While major, minor and patch will do a best effort to adhere to [Semantic Versioning](https://semver.org/),
6666
prepending it with an additional api version makes life easier for developers of client implementations
67-
in two ways: It is a clear way for the Lavalink project to communicate the actually relevant breaking changes
67+
in two ways: It is a clear way for the Lavalink project to communicate the actually relevant breaking changes
6868
to client developers, and in turn, client developers can use the api version to clearly communicate to their
6969
users about the compatibility of their clients to the Lavalink server.
7070

@@ -91,6 +91,7 @@ users about the compatibility of their clients to the Lavalink server.
9191
* [DSharpPlus.Lavalink](https://github.com/DSharpPlus/DSharpPlus/tree/master/DSharpPlus.Lavalink) ([DSharpPlus](https://github.com/DSharpPlus/DSharpPlus/), .NET)
9292
* [Lavalink4NET](https://github.com/angelobreuer/Lavalink4NET) ([Discord.Net](https://github.com/RogueException/Discord.Net), [DSharpPlus](https://github.com/DSharpPlus/DSharpPlus/), .NET)
9393
* [gavalink](https://github.com/foxbot/gavalink) (Go)
94+
* [waterlink](https://github.com/lukasl-dev/waterlink) (Go)
9495
* [Magma](https://github.com/initzx/magma/) (discord.py, Python)
9596
* [lavapotion](https://github.com/SamOphis/lavapotion) (Elixir)
9697
* [WaveLink](https://github.com/EvieePy/Wavelink) (discord.py, Python)

0 commit comments

Comments
 (0)