@danielbaars/anthracite 0.0.0-stage → 0.2.1

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
+# Anthracite
 
-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.
+A CLI for stacked Git branches and GitHub pull requests. Use **`an`** or **`anthracite`**.
+
+Anthracite builds on [Charcoal](https://github.com/danerwilliams/charcoal) and the formerly open-source Graphite CLI. See [credits and provenance](https://github.com/danielbaars/anthracite/blob/v0.2.1/CREDITS.md). It supports local stacks and GitHub PRs through `gh`; it does not implement every current Graphite feature or require a Graphite subscription.
+
+## Install
+
+Install the npm package with Node.js 24 or newer:
+
+```sh
+npm install --global @danielbaars/anthracite
+an --version
+```
+
+Git is required; GitHub workflows also require an installed, authenticated [GitHub CLI](https://cli.github.com/). npm installs both `an` and `anthracite`. It does not modify shell configuration. See [completion and migration from the standalone installer](https://github.com/danielbaars/anthracite/blob/v0.2.1/docs/installation.md).
+
+Standalone binaries for macOS ARM64, macOS x64 and Linux x64 are also available from [GitHub Releases](https://github.com/danielbaars/anthracite/releases). They do not require Node.js or Bun. From a clone, run `sh scripts/install.sh 0.1.1` to install that standalone release with checksum verification and zsh completion.
+
+```sh
+an --version
+an auth
+an init --trunk main
+an create my-change --message "Add my change"
+an modify --commit --message "Extend my change"
+an log short --stack
+an submit --stack --draft
+```
+
+Stage changes with Git before `create` or `modify`, or choose the command's staging options deliberately. Use `an <command> --help` for details.
+
+Use `an split --by-file 'path/**'` or `an sp -f path` to extract selected committed files into a prerequisite while retaining the original branch. See [file splitting, history and recovery](https://github.com/danielbaars/anthracite/blob/v0.2.1/docs/split.md).
+
+Use `an submit --reviewers alice --assignees @me --roles-branch my-change` to add roles only to one selected PR while retaining the usual submission scope. See [reviewers, assignees and submission scope](https://github.com/danielbaars/anthracite/blob/v0.2.1/docs/submit.md).
+
+To uninstall an npm installation, run `npm uninstall --global @danielbaars/anthracite`. For a standalone installation, remove the command links and managed completion block using `sh scripts/uninstall.sh` from a clone. Version directories and preferences are retained for rollback. See [installation and upgrades](https://github.com/danielbaars/anthracite/blob/v0.2.1/docs/installation.md), the [command reference](https://github.com/danielbaars/anthracite/blob/v0.2.1/DOCUMENTATION.md), and [compatibility](https://github.com/danielbaars/anthracite/blob/v0.2.1/COMPATIBILITY.md).
+
+## MCP
+
+Coding agents can use `an mcp` or `anthracite mcp` as a local stdio server. See [MCP configuration, tools and recovery](https://github.com/danielbaars/anthracite/blob/v0.2.1/docs/mcp.md) for a generic client configuration, explicit request arguments, execution limits and interruption behavior.
+
+## Development
+
+See [CONTRIBUTING.md](https://github.com/danielbaars/anthracite/blob/v0.2.1/CONTRIBUTING.md) for pinned build tools, tests and release preparation. Source code, documentation, commit messages, issues and pull requests in this repository are written in English.
+
+Licensed under the GNU Affero General Public License version 3; see [LICENSE](https://github.com/danielbaars/anthracite/blob/v0.2.1/LICENSE) and [CREDITS.md](https://github.com/danielbaars/anthracite/blob/v0.2.1/CREDITS.md).