Skip to content

Commit d4c03cb

Browse files
committed
docs: update readme and links fixes
1 parent ecdbccd commit d4c03cb

File tree

13 files changed

+34
-25
lines changed

13 files changed

+34
-25
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@
66
[build]: https://img.shields.io/github/actions/workflow/status/TrigenSoftware/simple-release-tools/tests.yml?branch=main
77
[build-url]: https://github.com/TrigenSoftware/simple-release-tools/actions
88

9-
[coverage]: https://img.shields.io/codecov/c/github/TrigenSoftware/simple-release-tools.svg
10-
[coverage-url]: https://app.codecov.io/gh/TrigenSoftware/simple-release-tools
9+
[coverage]: https://coveralls.io/repos/github/TrigenSoftware/simple-release/badge.svg?branch=main
10+
[coverage-url]: https://coveralls.io/github/TrigenSoftware/simple-release?branch=main
1111

12-
A simple tool to release projects with monorepo support.
12+
A simple tool to automate version bumps, changelogs, and releases using [Conventional Commits](https://conventionalcommits.org).
1313

14-
## Available tools
14+
- 📄 Uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) to parse commits, determine the next version, and generate a changelog.
15+
- 🗂️ Supports monorepos and can release multiple packages in a single run.
16+
- 🧩 Flexible and extensible with custom addons for different project types.
17+
- 🚀 Has [GitHub Action](https://github.com/TrigenSoftware/simple-release-action) to automate releases in CI/CD pipelines.
18+
19+
## Available packages
1520

1621
| Name | Description | Version | Dependencies |
1722
|------|-------------|---------|--------------|

packages/ci/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"url": "https://github.com/dangreen"
1111
},
1212
"license": "MIT",
13-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/ci#readme",
13+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/ci#readme",
1414
"funding": "https://ko-fi.com/dangreen",
1515
"repository": {
1616
"type": "git",

packages/config/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "https://github.com/dangreen"
1010
},
1111
"license": "MIT",
12-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/config#readme",
12+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/config#readme",
1313
"funding": "https://ko-fi.com/dangreen",
1414
"repository": {
1515
"type": "git",

packages/core/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@
2929
[coverage]: https://coveralls.io/repos/github/TrigenSoftware/simple-release/badge.svg?branch=main
3030
[coverage-url]: https://coveralls.io/github/TrigenSoftware/simple-release?branch=main
3131

32-
A simple tool to release projects with monorepo support.
32+
A simple tool to automate version bumps, changelogs, and releases using [Conventional Commits](https://conventionalcommits.org).
33+
34+
- 📄 Uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) to parse commits, determine the next version, and generate a changelog.
35+
- 🗂️ Supports monorepos and can release multiple packages in a single run.
36+
- 🧩 Flexible and extensible with custom addons for different project types.
37+
- 🚀 Has [GitHub Action](https://github.com/TrigenSoftware/simple-release-action) to automate releases in CI/CD pipelines.
3338

3439
<hr />
3540
<a href="#install">Install</a>
@@ -94,9 +99,7 @@ await new Releaser({
9499
.commit()
95100
.tag()
96101
.push()
97-
.release(new GithubReleaseCreator({
98-
token: process.env.GITHUB_TOKEN
99-
}))
102+
.release()
100103
.publish()
101104
.run()
102105
```
@@ -116,7 +119,7 @@ await new Releaser({
116119
| Step | Description |
117120
| --- | --- |
118121
| checkout | Checkout the desired branch. |
119-
| bump | Bump the version of the project. |
122+
| bump | Bump the version of the project and generate changelog. |
120123
| commit | Commit the changes with the new version. |
121124
| tag | Tag the commit with the new version. |
122125
| push | Push the changes to the remote repository. |
@@ -126,9 +129,9 @@ await new Releaser({
126129

127130
## Addons
128131

129-
- [npm](https://github.com/TrigenSoftware/simple-release/tree/main/packages/npm)
130-
- [pnpm](https://github.com/TrigenSoftware/simple-release/tree/main/packages/pnpm)
131-
- [github-release](https://github.com/TrigenSoftware/simple-release/tree/main/packages/github-release)
132+
- [npm](https://github.com/TrigenSoftware/simple-release/tree/main/packages/npm) - for projects using `npm` as a package manager.
133+
- [pnpm](https://github.com/TrigenSoftware/simple-release/tree/main/packages/pnpm) - for projects using `pnpm` as a package manager.
134+
- [github](https://github.com/TrigenSoftware/simple-release/tree/main/packages/github) - for projects hosted on GitHub.
132135

133136
## Custom addons
134137

packages/core/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
"name": "@simple-release/core",
33
"type": "module",
44
"version": "2.0.0",
5-
"description": "A simple tool to release projects with monorepo support.",
5+
"description": "A simple tool to automate version bumps, changelogs, and releases using Conventional Commits.",
66
"author": {
77
"name": "Dan Onoshko",
88
"email": "[email protected]",
99
"url": "https://github.com/dangreen"
1010
},
1111
"license": "MIT",
12-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/core#readme",
12+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/core#readme",
1313
"funding": "https://ko-fi.com/dangreen",
1414
"repository": {
1515
"type": "git",
@@ -28,6 +28,7 @@
2828
"monorepo",
2929
"workspaces",
3030
"conventional-changelog",
31+
"conventional-commits",
3132
"github"
3233
],
3334
"engines": {

packages/github-action/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ action
103103

104104
You can pass additional options to releaser via comment in your pull request. Your comment should start with `!simple-release/set-options` and contain JSON object with options. For example:
105105

106-
````
106+
````md
107107
!simple-release/set-options
108108

109109
```json

packages/github-action/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "https://github.com/dangreen"
1010
},
1111
"license": "MIT",
12-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/github-action#readme",
12+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/github-action#readme",
1313
"funding": "https://ko-fi.com/dangreen",
1414
"repository": {
1515
"type": "git",

packages/github/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "https://github.com/dangreen"
1010
},
1111
"license": "MIT",
12-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/github#readme",
12+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/github#readme",
1313
"funding": "https://ko-fi.com/dangreen",
1414
"repository": {
1515
"type": "git",

packages/npm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "https://github.com/dangreen"
1010
},
1111
"license": "MIT",
12-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/npm#readme",
12+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/npm#readme",
1313
"funding": "https://ko-fi.com/dangreen",
1414
"repository": {
1515
"type": "git",

packages/pnpm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "https://github.com/dangreen"
1010
},
1111
"license": "MIT",
12-
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/master/packages/pnpm#readme",
12+
"homepage": "https://github.com/TrigenSoftware/simple-release/tree/main/packages/pnpm#readme",
1313
"funding": "https://ko-fi.com/dangreen",
1414
"repository": {
1515
"type": "git",

0 commit comments

Comments
 (0)