@beremaran/ralphie 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Beremaran
+
+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,54 @@
-# Temporary Holding Version
+# Ralphie
 
-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.
+**Turn a GitHub issue queue into reviewed commits with a coding-agent harness.**
+
+[![CI](https://github.com/beremaran/ralphie/actions/workflows/ci.yml/badge.svg)](https://github.com/beremaran/ralphie/actions/workflows/ci.yml)
+
+Ralphie is an opinionated CLI that reads open GitHub issues, asks
+a headless coding-agent harness (Claude Code first) for schema-validated
+decisions, and
+routes each issue to either focused implementation or dependency-aware
+decomposition. Agents handle reasoning and code changes; Ralphie keeps Git,
+GitHub, run state, diagnostics, and safety checks deterministic.
+
+> [!CAUTION]
+> Ralphie works directly on the branch selected in the configuration file, commits approved
+> work, and pushes directly to that branch. Ralphie is pre-1.0. Validate against
+> a repository you control before enabling mutations.
+
+## Quick start
+
+Run the latest release without installing globally:
+
+```bash
+bunx @beremaran/ralphie --version
+```
+
+Write a starter config with `bunx @beremaran/ralphie init` (it detects the
+harnesses on PATH; see [Configuration](./docs/configuration.md)), then run the
+issue queue:
+
+```bash
+bunx @beremaran/ralphie owner/repository
+```
+
+See [Getting started](./docs/getting-started.md) for prerequisites,
+authentication, verification, and the full first-run contract, and read the
+[safety model](./docs/safety.md) before enabling mutations.
+
+## Documentation
+
+Start with the [documentation index](./docs/README.md). Audience entry points:
+
+- New user: [Getting started](./docs/getting-started.md), then
+  [Safety](./docs/safety.md).
+- Operator: [Workflows](./docs/workflows.md),
+  [CLI reference](./docs/cli-reference.md), and
+  [Operations and recovery](./docs/operations-and-recovery.md).
+- Contributor: [Development](./docs/development.md) and
+  [Architecture](./docs/architecture.md).
+- Release maintainer: [Publishing](./docs/development.md#publishing).
+
+## License
+
+Ralphie is [MIT licensed](./LICENSE).