@workit-dev/pi 0.0.1 → 1.0.0

package/README.md

@@ -1,45 +1,26 @@
 # @workit-dev/pi
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@workit-dev/pi`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+[![CI](https://github.com/BrainerVirus/workit/actions/workflows/ci.yml/badge.svg)](https://github.com/BrainerVirus/workit/actions/workflows/ci.yml)
+[![license: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/BrainerVirus/workit/blob/main/LICENSE)
+
+[Workit](https://github.com/BrainerVirus/workit) for Pi (stock 1.4.0): a native extension with the
+seven task families plus read-only `workit_context`, the thirteen method
+skills, session and compaction continuity, and a coordinator that launches
+fresh reviewer/investigator processes and scoped implementers. Requires
+Node.js 24+.
+
+```bash
+pi install npm:@workit-dev/pi
+pi install ./packages/workit-pi -l --approve   # local checkout
+```
+
+Update with `workit upgrade` (native fallback: `pi update --extension npm:@workit-dev/pi`); uninstall with `workit uninstall`.
+
+Pi discovers the extension and skills from the package's `pi` manifest
+(`./dist/workit.js`, `./skills`). Pi project trust still gates mutations.
+The `tool_call` boundary applies branch policy and the
+[before-write gate](https://github.com/BrainerVirus/workit/blob/main/docs/guides/verification.md) to write, edit and recognizable bash
+writes (unrecognized shell writes stay agent-guided; an extension is not an OS
+sandbox). Tools take flat fields.
+Delivery limits come from Pi's permissions plus the workspace
+[grants](https://github.com/BrainerVirus/workit/blob/main/docs/guides/grants.md).