mirror
/
websocket
mirror of https://github.com/gorilla/websocket.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
websocket/README.md

37 lines
1.8 KiB
Markdown
Raw Normal View History

adds GHA & Makefile configs
2024-04-04 21:57:39 +03:00
# gorilla/websocket
Initial commit
2013-10-16 20:41:47 +04:00
adds GHA & Makefile configs
2024-04-04 21:57:39 +03:00
![testing](https://github.com/gorilla/websocket/actions/workflows/test.yml/badge.svg)
[![codecov](https://codecov.io/github/gorilla/websocket/branch/main/graph/badge.svg)](https://codecov.io/github/gorilla/websocket)
[![godoc](https://godoc.org/github.com/gorilla/websocket?status.svg)](https://godoc.org/github.com/gorilla/websocket)
[![sourcegraph](https://sourcegraph.com/github.com/gorilla/websocket/-/badge.svg)](https://sourcegraph.com/github.com/gorilla/websocket?badge)
Create CircleCI config.yml (#519) * Create config.yml * Delete .travis.yml * Added CircleCI badge to README * Add golint; run on latest only
2019-06-29 21:55:28 +03:00
adds GHA & Makefile configs
2024-04-04 21:57:39 +03:00
Gorilla WebSocket is a [Go](http://golang.org/) implementation of the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol.
![Gorilla Logo](https://github.com/gorilla/.github/assets/53367916/d92caabf-98e0-473e-bfbf-ab554ba435e5)
Initial commit
2013-10-16 20:41:47 +04:00
Update README (#757) - Note that a new maintainer is needed. - Remove comparison with x/net/websocket. There's no need to describe the issues with that package now that the package's documentation points people here and elsewhere.
2022-01-04 04:49:10 +03:00
Add more information to README.md.
2013-10-29 17:29:20 +04:00
### Documentation
Initial commit
2013-10-16 20:41:47 +04:00
Changed the link of API references to pkg.go.dev (#577)
2020-03-19 16:46:16 +03:00
* [API Reference](https://pkg.go.dev/github.com/gorilla/websocket?tab=doc)
Update README.md, replace master to main (#862) <!-- For Work In Progress Pull Requests, please use the Draft PR feature, see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. For a timely review/response, please avoid force-pushing additional commits if your PR already received reviews or comments. Before submitting a Pull Request, please ensure that you have: - 📖 Read the Contributing guide: https://github.com/gorilla/.github/blob/main/CONTRIBUTING.md - 📖 Read the Code of Conduct: https://github.com/gorilla/.github/blob/main/CODE_OF_CONDUCT.md - Provide tests for your changes. - Use descriptive commit messages. - Comment your code where appropriate. - Squash your commits - Update any related documentation. - Add gorilla/pull-request-reviewers as a Reviewer --> ## What type of PR is this? (check all applicable) - [ ] Refactor - [ ] Feature - [ ] Bug Fix - [ ] Optimization - [x] Documentation Update - [ ] Go Version Update - [ ] Dependency Update ## Description ## Related Tickets & Documents <!-- For pull requests that relate or close an issue, please include them below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). For example having the text: "closes #1234" would connect the current pull request to issue 1234. And when we merge the pull request, Github will automatically close the issue. --> - Related Issue # - Closes # ## Added/updated tests? - [ ] Yes - [x] No - [ ] I need help with writing tests ## Run verifications and test - [ ] `make verify` is passing - [ ] `make test` is passing
2023-11-08 21:57:41 +03:00
* [Chat example](https://github.com/gorilla/websocket/tree/main/examples/chat)
* [Command example](https://github.com/gorilla/websocket/tree/main/examples/command)
* [Client and server example](https://github.com/gorilla/websocket/tree/main/examples/echo)
* [File watch example](https://github.com/gorilla/websocket/tree/main/examples/filewatch)
* [Write buffer pool example](https://github.com/gorilla/websocket/tree/main/examples/bufferpool)
Initial commit
2013-10-16 20:41:47 +04:00
Add more information to README.md.
2013-10-29 17:29:20 +04:00
### Status
Initial commit
2013-10-16 20:41:47 +04:00
Add more information to README.md.
2013-10-29 17:29:20 +04:00
The Gorilla WebSocket package provides a complete and tested implementation of
the [WebSocket](http://www.rfc-editor.org/rfc/rfc6455.txt) protocol. The
Improve comparison with other packages in readme.
2014-04-19 18:16:39 +04:00
package API is stable.
Initial commit
2013-10-16 20:41:47 +04:00
Add more information to README.md.
2013-10-29 17:29:20 +04:00
### Installation
Initial commit
2013-10-16 20:41:47 +04:00
go get github.com/gorilla/websocket
Add more information to README.md.
2013-10-29 17:29:20 +04:00
### Protocol Compliance
Update readme files - Improve comparison with go.net package. - Improve autobahn server description.
2014-04-21 08:14:06 +04:00
The Gorilla WebSocket package passes the server tests in the [Autobahn Test
Updated autobahn test suite URL Fixes #436
2018-12-06 10:02:39 +03:00
Suite](https://github.com/crossbario/autobahn-testsuite) using the application in the [examples/autobahn
adds GHA & Makefile configs
2024-04-04 21:57:39 +03:00
subdirectory](https://github.com/gorilla/websocket/tree/main/examples/autobahn).