autorel 0.0.30 → 0.0.32

package/README.md

@@ -20,26 +20,27 @@ Autorel automatically does the following, if appropriate:
 - Runs any arbitrary command or bash script after the release is complete
 
 **✅ Conventional Commit and SemVer Compliant**
--`autorel` is 100% compliant with Conventional Commits and SemVer out of the box, including "!" for breaking changes
+- 100% compliant with Conventional Commits and SemVer out of the box, including "!" for breaking changes
 
 **😃 Simple & Easy to Use**
 - No confusing configuration files or complex setup
 - Works with any CI/CD system, including GitHub Actions
 - Built-in TypeScript and bash script support
 
-**💪 Flexible & Powerful**
-- Use via `npx`, or import as a library
-- If using CLI, supports both `yaml` configuration and arguments
-- Highly customizable without being overly complex
+**🚀 Fast & Lightweight**
+- Minimal dependencies and fast execution
+- Less broken builds and more time to focus on your code!
 
 # Table of Contents
 
 - [Example Usage (CLI)](#example-usage-cli)
 - [Example Usage (Library)](#example-usage-library)
 - [Usage with GitHub Actions](#usage-with-github-actions)
+- [Example Commit Messages](#example-commit-messages)
 - [Configuration](#configuration)
 - [Sample YAML Configuration](#sample-yaml-configuration)
 - [Types](#types)
+- [Debug Mode](#debug-mode)
 - [Support, Feedback, and Contributions](#support-feedback-and-contributions)
 
 # Example Usage (CLI)
@@ -55,7 +56,7 @@ This will:
 3. Publish the release to NPM
 4. Run the command `echo "Next version is ${NEXT_VERSION}"`
 
-You can also install `autorel` globally and run it that way:
+You can also install `autorel` globally and run it directly:
 
 ```bash
 npm i -g autorel
@@ -125,11 +126,21 @@ jobs:
         run: npx autorel --publish
 ```
 
+# Example Commit Messages
+
+Here are some examples of commit messages and the resulting version bump (default configuration):
+
+- `fix: fix a bug` -> `0.0.1`
+- `feat: add new feature` -> `0.1.0`
+- `feat!: add breaking change` -> `1.0.0`
+
+You can find more examples in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) documentation.
+
 # Configuration
 
 When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.
 
-When used as a library, you can pass the configuration directly to the `autorel` function. [See below](#types) for the types of configuration options.
+When used as a library, you can pass the configuration directly to the `autorel` function.
 
 All arguments are optional, but setting `branches` is recommended.
 
@@ -259,6 +270,16 @@ run: echo 'Hello, World!'
 
 You can find the types defined at [src/index.ts](src/index.ts).
 
+# Debug Mode
+
+To enable debug mode, set `AUTOREL_DEBUG=1`:
+
+```bash
+AUTOREL_DEBUG=1 npx autorel
+```
+
+This will output configuration and other debug information.
+
 # Support, Feedback, and Contributions
 
 - Star this repo if you like it!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "description": "Automate semantic releases based on conventional commits. Similar to semantic-release but much simpler.",
   "license": "MIT",
   "author": "Marc H. Weiner <mhweiner234@gmail.com> (https://mhweiner.com)",