eraspace 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 shujanshaikh
+
+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.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# eraspace
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Build and deploy realtime apps written in TypeScript. The server runs on the BEAM with Postgres storage, live queries
+and WebSockets; the client is Preact. Apps need no `package.json`, `tsconfig.json` or `node_modules`: the CLI bundles
+the SDK, Preact and TypeScript.
+
+Requires Node.js 24 or newer.
+
+## Quick start
+
+```bash
+npx eraspace new my-app            # templates: --template chat | todo | poll
+cd my-app
+npx eraspace deploy                # prints the app URL
+```
+
+A deploy without an account creates an unclaimed app. It works straight away and expires after about a week unless you
+sign in and claim it (`eraspace auth login`, then `eraspace claim`).
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `new <name>` / `init` | Create an app in a new directory or the current one |
+| `typecheck` | Typecheck `server/`, `client/` and `shared/` |
+| `deploy` | Build the client, compile the server and deploy |
+| `dev` | Deploy, then redeploy on every save |
+| `call <fn> '<json>'...` | Call a query, mutation or action |
+| `logs` | Read handler logs (`--follow` to stream) |
+| `inspect` | Show the schema, functions and deploys |
+| `auth login` / `claim` | Sign in, and take ownership of an unclaimed app |
+
+`eraspace --help` and `eraspace <command> --help` list every flag.
+
+## Platform
+
+The CLI deploys to the hosted eraspace platform by default. Set `ERASPACE_URL` or pass `--url` to use another one, such
+as a local platform at `http://localhost:4000`.