From 096add66d19222ee07ee7a4a96b4d2fde3bef00f Mon Sep 17 00:00:00 2001 From: Ben Reinhart Date: Mon, 11 Nov 2024 12:36:46 -0800 Subject: [PATCH] Add badges and rename license file --- LICENSE => LICENSE.md | 0 README.md | 5 +++++ 2 files changed, 5 insertions(+) rename LICENSE => LICENSE.md (100%) diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index 89ff73d..db3cc80 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # ServerSentEvents +[![CI](https://github.com/benjreinhart/server_sent_events/actions/workflows/ci.yml/badge.svg)](https://github.com/benjreinhart/server_sent_events/actions/workflows/ci.yml) +[![License](https://img.shields.io/hexpm/l/server_sent_events.svg)](https://github.com/benjreinhart/server_sent_events/blob/main/LICENSE.md) +[![Version](https://img.shields.io/hexpm/v/server_sent_events.svg)](https://hex.pm/benjreinhart/server_sent_events) +[![Hex Docs](https://img.shields.io/badge/documentation-gray.svg)](https://hexdocs.pm/server_sent_events) + Lightweight, ultra-fast Server Sent Event parser for Elixir. This module fully conforms to the official [Server Sent Events specification](https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream) with a comprehensive [test suite](https://github.com/benjreinhart/server_sent_events/blob/main/test/server_sent_events_test.exs).