better-sse 0.15.0 → 0.16.0

package/README.md

@@ -1,10 +1,19 @@
 # Better SSE
 
 <p>
-	<img src="https://img.shields.io/npm/v/better-sse?color=blue&style=flat-square" />
-	<img src="https://img.shields.io/npm/l/better-sse?color=green&style=flat-square" />
-	<img src="https://img.shields.io/npm/dt/better-sse?color=grey&style=flat-square" />
-	<a href="https://github.com/MatthewWid/better-sse"><img src="https://img.shields.io/github/stars/MatthewWid/better-sse?style=social" /></a>
+    <a href="https://www.npmjs.com/package/better-sse">
+        <img src="https://img.shields.io/npm/v/better-sse?color=blue&style=flat-square" alt="npm" />
+    </a>
+    <a href="https://jsr.io/@mwid/better-sse">
+        <img src="https://jsr.io/badges/@mwid/better-sse" alt="jsr" />
+    </a>
+    <a href="https://github.com/MatthewWid/better-sse/blob/master/LICENSE">
+        <img src="https://img.shields.io/npm/l/better-sse?color=green&style=flat-square" alt="MIT license" />
+    </a>
+	<img src="https://img.shields.io/npm/dt/better-sse?color=grey&style=flat-square" alt="Downloads" />
+	<a href="https://github.com/MatthewWid/better-sse">
+        <img src="https://img.shields.io/github/stars/MatthewWid/better-sse?style=social" alt="GitHub stars" />
+    </a>
 </p>
 
 A dead simple, dependency-less, spec-compliant server-sent events implementation written in TypeScript.
@@ -30,7 +39,7 @@ Read the [Getting Started](https://matthewwid.github.io/better-sse/guides/gettin
 
 ## Highlights
 
-* Compatible with all popular HTTP frameworks ([Express](https://nodejs.org/api/http.html), [Hono](https://hono.dev/), [Fastify](https://fastify.dev/), [Nest](https://nestjs.com/), [Next.js](https://nextjs.org/), [Bun](https://bun.sh/docs/api/http), [Deno](https://docs.deno.com/runtime/fundamentals/http_server/), [etc.](https://matthewwid.github.io/better-sse/reference/recipes/))
+* Compatible with all popular frameworks and runtimes ([Express](https://nodejs.org/api/http.html), [Hono](https://hono.dev/), [Fastify](https://fastify.dev/), [Nest](https://nestjs.com/), [Next.js](https://nextjs.org/), [Bun](https://bun.sh/docs/api/http), [Deno](https://docs.deno.com/runtime/fundamentals/http_server/), [etc.](https://matthewwid.github.io/better-sse/reference/recipes/))
 * Fully written in TypeScript (+ ships with types directly).
 * [Thoroughly tested](./src/Session.test.ts) (+ 100% code coverage!).
 * [Comprehensively documented](https://matthewwid.github.io/better-sse) with guides and API documentation.
@@ -47,7 +56,7 @@ Read the [Getting Started](https://matthewwid.github.io/better-sse/guides/gettin
 
 # Installation
 
-Install with any package manager:
+Better SSE is published as a package on [npm](https://www.npmjs.com/package/better-sse) and the [JSR](https://jsr.io/@mwid/better-sse). You can install it with any package manager:
 
 ```sh
 npm install better-sse
@@ -66,7 +75,7 @@ bun add better-sse
 ```
 
 ```sh
-deno install npm:better-sse
+deno install jsr:@mwid/better-sse
 ```
 
 _Better SSE ships with types built in. No need to install from DefinitelyTyped for TypeScript users!_
@@ -106,7 +115,7 @@ app.get("/sse", (c) =>
 // Client
 const eventSource = new EventSource("/sse")
 
-eventSource.addEventListener("message", ({ data })) => {
+eventSource.addEventListener("message", ({ data }) => {
 	const contents = JSON.parse(data)
 	console.log(contents) // Hello world!
 })
@@ -158,7 +167,7 @@ Check the [API documentation](https://matthewwid.github.io/better-sse/reference/
 
 # Documentation
 
-API documentation, getting started guides and usage with other frameworks is [available on the documentation website](https://matthewwid.github.io/better-sse/).
+See [the documentation website](https://matthewwid.github.io/better-sse/) for guides, usage examples, compatibility information and an API reference.
 
 # Contributing
 
@@ -203,6 +212,29 @@ Bundle for distribution (with [tsup](https://tsup.egoist.dev/)):
 pnpm build
 ```
 
+## Documentation
+
+The documentation is built with [Astro](https://astro.build/) and [Starlight](https://starlight.astro.build/). Its source is located in the `docs` directory.
+
+Install dependencies:
+
+```bash
+cd docs
+pnpm i
+```
+
+Run development server:
+
+```bash
+pnpm dev
+```
+
+Build for distribution:
+
+```bash
+pnpm build
+```
+
 # License
 
 This project is licensed under the [MIT license](https://opensource.org/license/mit/).