Skip to content

Commit 1c2e77b

Browse files
committed
README.md: promote dom/v2 API stability
The dom/v2 API tried to stay as close as possible to its original API, but reimplemented on top of syscall/js API for increased compatibility. This happened 4 years ago (see PR #69). The "Alpha, more API changes may be done soon" stage was meant give us room to make significant changes in case we needed to. Given how much time has passed and it's been working okay, we're way past that stage and at a point where significant breaking API changes would not happen in v2. Update the README to say that now, even if it's way overdue. Also update documentation links while here.
1 parent 5d8aaae commit 1c2e77b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Package dom provides Go bindings for the JavaScript DOM APIs.
44

55
## Version 2
66

7-
**API Status:** Alpha, more API changes may be done soon
7+
**API Status:** Stable, changes only due to DOM being a moving target
88

9-
Version 2 of package dom is implemented on top of the [`syscall/js`](https://godoc.org/syscall/js) API and supports both Go WebAssembly and GopherJS.
9+
Version 2 of package dom is implemented on top of the [`syscall/js`](https://go.dev/pkg/syscall/js) API and supports both Go WebAssembly and GopherJS.
1010

1111
It provides an API that is as close as possible to v1, with the following neccessary changes:
1212

@@ -20,18 +20,18 @@ It provides an API that is as close as possible to v1, with the following necces
2020

2121
### Documentation
2222

23-
For documentation, see https://godoc.org/honnef.co/go/js/dom/v2.
23+
For documentation, see https://pkg.go.dev/honnef.co/go/js/dom/v2.
2424

2525
## Version 1
2626

2727
**API Status:** Stable, changes only due to DOM being a moving target
2828

29-
Version 1 of package dom is implemented on top of the [`github.com/gopherjs/gopherjs/js`](https://godoc.org/github.com/gopherjs/gopherjs/js) API and supports GopherJS only.
29+
Version 1 of package dom is implemented on top of the [`github.com/gopherjs/gopherjs/js`](https://pkg.go.dev/github.com/gopherjs/gopherjs/js) API and supports GopherJS only.
3030

3131
### Install
3232

3333
go get honnef.co/go/js/dom
3434

3535
### Documentation
3636

37-
For documentation, see https://godoc.org/honnef.co/go/js/dom.
37+
For documentation, see https://pkg.go.dev/honnef.co/go/js/dom.

0 commit comments

Comments
 (0)