Add readme, fix package.json and add deno.json to test dir

README.md

@@ -0,0 +1,29 @@
+# deno-http-worker
+
+Similarly to [deno-vm](https://github.com/casual-simulation/node-deno-vm), deno-http-worker lets you securely spawn Deno http servers.
+
+## Usage
+
+```ts
+import { newDenoHTTPWorker } from 'deno-http-worker';
+
+let worker = await newDenoHTTPWorker(
+    `export default async function (req: Request): Promise<Response> {
+        return Response.json({ ok: req.url })
+    }`,
+    { printOutput: true, runFlags: ["--alow-net"] }
+);
+
+let json = await worker.client
+    .get("https://hello/world?query=param")
+    .json();
+console.log(json) // => { ok: 'https://hello/world?query=param' }
+
+worker.terminate();
+```
+
+## Internals
+
+When spawning the Deno process deno-http-worker connects to the process over a Unix socket. This is for performance and efficiency. As a result, the worker does not provide an address to make requests to, but instead returns an instance of a [got](https://www.npmjs.com/package/got) client that you can make requests with. This ensures that only the underlying `http2.ClientHttp2Session` is used to make requests.
+
+If you need more advanced usage that cannot be covered by `got`, please open a ticket.

package.json

@@ -1,9 +1,9 @@
 {
   "name": "deno-http-worker",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "",
-  "main": "dist/plugin.js",
-  "types": "./dist/plugin.d.ts",
+  "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "test": "vitest run",
     "test:watch": "vitest",

src/test/deno.json

@@ -0,0 +1 @@
+{ "lock": false }