autorel 0.0.18 → 0.0.20

package/README.md

@@ -75,11 +75,11 @@ This will do the same as the CLI example above.
 
 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.
+When used as a library, you can pass the configuration directly to the `autorel` function. [See below](#types) for the types of configuration options.
 
 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.
+> ❗️ The `yaml` configuration file must be named `.autorel.yml` and be in the root of your project.
 
 ## help (CLI only)
 
@@ -138,7 +138,7 @@ runScript: |
 
 ## tag
 
-The tag to use for the release. Note that this will skip the commit message analysis and use the tag verbatim. Always results in a release being created unless `noRelease` is `true`. Advanced usage only.
+The tag to use for the release. This will be used verbatim, instead of being generated from the version number. Always results in a release being created unless `noRelease` is `true`. **Advanced usage only.**
 
 - CLI: `--tag`
 - Argument: `tag: string`
@@ -200,59 +200,14 @@ run: echo 'Hello, World!'
 
 # Types
 
-## CommitType
+You can find the types defined at [src/index.ts](src/index.ts).
 
-```typescript
-type CommitType = {
-  type: string;
-  title: string;
-  release: 'major' | 'minor' | 'patch' | 'none';
-};
-```
-
-## ReleaseBranch
-
-```typescript
-type ReleaseBranch = {
-  name: string;
-  channel?: string;
-};
-```
-
-## Config
-
-```typescript
-type Config = {
-  run?: string;
-  publish?: boolean;
-  dryRun?: boolean;
-  noRelease?: boolean;
-  tag?: string;
-  pre?: string;
-  breakingChangeTitle?: string;
-  commitTypes?: CommitType[];
-  branches?: ReleaseBranch[];
-};
-```
-
-## Contribution
-
-Please contribute to this project! Issue a PR against `main` and request review. 
+# Support, Feedback, and Contributions
 
-- Please test your work thoroughly.
-- Make sure all tests pass with appropriate coverage.
-
-### How to build locally
-
-```bash
-npm i
-```
-
-### Running tests
-
-```shell script
-npm test
-```
+- Star this repo if you like it!
+- Submit an [issue](https://github.com/mhweiner/jsout/issues) with your problem, feature request or bug report
+- Issue a PR against `main` and request review. Make sure all tests pass and coverage is good.
+- Write about `autorel` in your blog, tweet about it, or share it with your friends!
 
 ## Sponors
 

package/package.json

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