Skip to content

Commit ab968b6

Browse files
committed
README: note about upgrading to v2
1 parent fff77a7 commit ab968b6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Go check out [this README on the `v2` branch](https://github.com/markus-wa/demoi
2323

2424
## Requirements
2525

26-
This library is intended to be used with `go 1.11` or higher as it is built using Go modules.
26+
This library should be used with `go 1.11` or higher as it is built using Go modules.
2727

2828
It's recommended to use modules for consumers as well if possible.
2929
If you are unfamiliar with Go modules there's a [list of recommended resources](https://github.com/markus-wa/demoinfocs-golang/wiki/Go-Modules#recommended-links--articles) in the wiki.
@@ -32,6 +32,12 @@ If you are unfamiliar with Go modules there's a [list of recommended resources](
3232

3333
go get -u github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs
3434

35+
## Upgrading from v1.x to v2
36+
37+
If you are currently using version 1.x of this library, check out [this wiki page](https://github.com/markus-wa/demoinfocs-golang/wiki/Upgrading-from-v1.x-to-v2.0.0) for an upgrade guide.
38+
39+
The old code is also still available in the [`v1` branch](https://github.com/markus-wa/demoinfocs-golang/tree/v1) if you need it.
40+
3541
## Example
3642

3743
This is a simple example on how to handle game events using this library.

0 commit comments

Comments
 (0)