autorel 0.0.16 → 0.0.18

package/README.md

@@ -39,12 +39,12 @@ npx autorel --publish --run "echo 'Hello, World!'"
 
 This will:
 
-1. Bump the version based on the commit messages, push the new tag, and change the package.json version
+1. Bump the version based on the commit messages since the last release (including pushing the tag and updating package.json)
 2. Create a new release on GitHub with Release Notes
 3. Publish the release to NPM
-4. Run the command `echo 'Hello, World!'` via `bash` and `child_process`
+4. Run the command `echo 'Hello, World!'`
 
-> If you don't want to use npx, you can also install `autorel` globally and run it that way:
+You can also install `autorel` globally and run it that way:
 
 ```bash
 npm i -g autorel
@@ -73,13 +73,13 @@ This will do the same as the CLI example above.
 
 # Configuration
 
-Unless otherwise noted, configuration can be done via `yaml`, file, CLI arguments, or any combination of the two. CLI arguments take precedence and will override the `yaml` file. 
+When run in CLI mode, `autorel` can be configured via CLI arguments or a `yaml` file. CLI arguments take precedence over the `yaml` file.
 
-You can also use the library in your project, in which case you can pass the options directly to the `autorel` function.
+When used as a library, you can pass the configuration directly to the `autorel` function.
 
 All arguments are optional, but setting `branches` is recommended.
 
-> If using yaml, the file must be named `autorel.yml` and be in the root of your project.
+> ❗️ If using yaml, the file must be named `.autorel.yml` and be in the root of your project.
 
 ## help (CLI only)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "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)",