From fa508af278cf0e5b492b0952b083910fd40fc8cb Mon Sep 17 00:00:00 2001
From: busticated <itsbusticated@gmail.com>
Date: Fri, 13 Oct 2023 20:02:23 -0700
Subject: [PATCH] add publishing instructions to README

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 258023e..750c00d 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,22 @@ Run `cargo xtask help` to see any other docs-related commands that are available
 </p>
 </details>
 
+<details id="develop-publish-crate">
+<summary><b>How to publish crates</b></summary>
+<p>
+
+To publish a crate to the [crates.io](https://crates.io) registry, follow these steps:
+
+1. Checkout the `main` branch: `git checkout main`
+2. Run `cargo xtask crate:release` and follow the prompts
+3. Verify all checks pass: `cargo xtask ci`
+4. Push to remote: `git push origin main --follow-tags`
+
+Each crate you select for publishing will be assigned its new version and all changes will be committed and tagged in `git`. The assigned tag will be formatted like `name@version` (e.g. `detect-newline-style@1.0.0`). After pushing to the remote, CI will execute the publishing steps and if all goes well, your crate will be available on [crates.io](https://crates.io).
+
+</p>
+</details>
+
 <details id="develop-todo">
 <summary><b>How to view and add TODO source code comments</b></summary>
 <p>