@gambrel/bun 0.2.0 → 0.2.2

package/README.md

@@ -1,19 +1,52 @@
-# @gambrel/bun
-
-`Bun.serve` adapter
-
-Part of [Gambrel](https://github.com/thenolle/gambrel), a small TypeScript-first, JSX-based full-stack framework for Bun.
-
-## Install
-
-```bash
-bun add @gambrel/bun
-```
-
-## Documentation
-
-See the [Gambrel documentation](https://github.com/thenolle/gambrel/tree/master/docs).
-
-## License
-
-Licensed under the PolyForm-Strict-1.0.0: noncommercial use only, no distribution, no modification. See the LICENSE file.
+# @gambrel/bun
+
+Bun server integration and static-file middleware for Gambrel.
+
+## Install
+
+```bash
+bun add @gambrel/bun @gambrel/core
+```
+
+## Serve an application
+
+```ts
+import { serve } from '@gambrel/bun'
+import { createApp } from '@gambrel/core'
+
+const app = createApp().get('/', () => 'Hello')
+const server = serve(app, { port: 3000 })
+
+console.log(server.url.href)
+```
+
+`serve` accepts `port`, `hostname`, and `development`. Use port 0 to request an available port.
+
+Call `await server.stop()` to stop the server.
+
+## Serve static files
+
+```ts
+import { staticFiles } from '@gambrel/bun'
+
+app.use(staticFiles({
+  directory: 'dist/client',
+  prefix: '/assets'
+}))
+```
+
+GET and HEAD requests under the prefix serve files from the directory. Missing files return a plain-text 404 rather than falling through to an HTML page.
+
+Keep the served directory limited to public assets. Do not place credentials or private data inside it.
+
+## Runtime
+
+Bun.
+
+## Documentation
+
+[Bun adapter reference](https://thenolle.github.io/gambrel/#/bun)
+
+## License
+
+PolyForm Strict License 1.0.0. See LICENSE for permitted uses and restrictions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gambrel/bun",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "`Bun.serve` adapter",
   "license": "PolyForm-Strict-1.0.0",
   "type": "module",
@@ -15,7 +15,7 @@
     }
   },
   "dependencies": {
-    "@gambrel/core": "^0.2.0"
+    "@gambrel/core": "^0.2.2"
   },
   "files": [
     "dist",