v3

bobbytxt · Jun 14, 2023 · 340fc8f · 340fc8f
1 parent 4b1acbf
commit 340fc8f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# v2.0.0
+
+-   This version of Ultraviolet has support for Bare server v3
+-   Support for older Bare servers was dropped.
+
 # v1.0.10
 
 -   This version of Ultraviolet fixes an NPM versioning error.

diff --git a/README.md b/README.md
@@ -31,6 +31,22 @@ Some of the popular websites that Ultraviolet supports include:
 -   [Nebula](https://github.com/NebulaServices/Nebula)
 -   [Metallic](https://github.com/Metallic-Web/Metallic)
 
+## Upgrading
+
+A guide for updating from v1 to v2 can be found [here](./docs/V2-UPGRADE-GUIDE.md).
+
+## Older Bare servers
+
+Starting from v2, Ultraviolet only supports Bare servers v3+.
+
+If you operate an outdated Bare server, we encourage you to update. If you're using an outdated Bare server, we encourage you to find an updated Bare server or host your own.
+
+If you're too lazy to do either of the above, you can install an outdated and unsupported version of Ultraviolet.
+
+```sh
+npm install @titaniumnetwork-dev/ultraviolet@1
+```
+
 ## Changelog
 
 Changes are documented in the [changelog](./CHANGELOG.md).

diff --git a/docs/V2-UPGRADE-GUIDE.md b/docs/V2-UPGRADE-GUIDE.md
@@ -0,0 +1,9 @@
+# Upgrade to Ultraviolet v2.x
+
+## No support for older Bare servers.
+
+In order to more effectively use newer APIs provided by newer implementations of bare-client, support folder older Bare servers has been dropped.
+
+You need to upgrade your Bare server in order to use Ultraviolet.
+
+See the [Bare server node upgrade guide](https://github.com/tomphttp/bare-server-node/blob/master/docs/V2-UPGRADE-GUIDE.md) for upgrading your Bare server.