diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dad338e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Floris Cornel + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0492c05 --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +# SSE - Server-Sent Events Writer + +[![GoDoc](https://godoc.org/github.com/floriscornel/sse?status.svg)](https://godoc.org/github.com/floriscornel/sse) +[![Go Report Card](https://goreportcard.com/badge/github.com/floriscornel/sse)](https://goreportcard.com/report/github.com/floriscornel/sse) +[![Codecov](https://img.shields.io/codecov/c/github/floriscornel/sse.svg)](https://codecov.io/gh/floriscornel/sse) +[![License](https://img.shields.io/github/license/floriscornel/sse.svg)](https://github.com/floriscornel/sse/blob/main/LICENSE) + +`sse` is a lightweight Go library for writing [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events). This library allows easy integration of SSE into web servers, providing real-time updates to connected clients. + +## Installation + +To install the `sse` package, use the following command: + +```bash +go get github.com/floriscornel/sse +``` + +## Usage + +### Importing the Package + +```go +import ( + "net/http" + "github.com/floriscornel/sse" +) +``` + +### Creating a Server-Sent Events Writer + +To create an SSE writer, use the `NewResponseWriter` function. This function requires an `http.ResponseWriter` and options to configure the SSE writer. + +```go +opts := sse.Options{ + ResponseStatus: http.StatusOK, + Encoding: sse.EncodeNone, +} + +func handler(w http.ResponseWriter, r *http.Request) { + sseWriter := sse.NewResponseWriter(w, opts) + + for { + err := sseWriter.Write("message", map[string]string{"hello": "world"}) + if err != nil { + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + time.Sleep(2 * time.Second) + } +} + +http.HandleFunc("/events", handler) +log.Fatal(http.ListenAndServe(":8080", nil)) +``` + +### Encoding Options + +The `sse` package supports various encoding options to compress the data sent to clients. Available encoding options include: + +- `EncodeNone` +- `EncodeDeflate` +- `EncodeCompress` +- `EncodeGzip` +- `EncodeBrotli` +- `EncodeZstd` + +Specify the desired encoding in the `Options` struct: + +```go +opts := sse.Options{ + ResponseStatus: http.StatusOK, + Encoding: sse.EncodeGzip, +} +``` + +## Examples + +You can find more examples in the `examples` directory. To run an example, navigate to the respective directory and execute the following command: + +```bash +go run main.go +``` + +### Example Structure + +- `ping`: A simple example of sending periodic ping messages to the client. +- `incremental-updates`: Demonstrates sending incremental updates to the client with different event types. +- `number-of-listeners`: Implements a counter to track the number of connected clients. + +## Contributing + +Contributions are welcome! Feel free to open issues or submit pull requests. For major changes, please open an issue first to discuss what you would like to change. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Contact + +If you have any questions, feel free to reach out: + +- **Author:** Floris Cornel +- **Email:** floris@cornel.email +- **GitHub:** [github.com/floriscornel/sse](https://github.com/floriscornel/sse)