Skip to content

Commit

Permalink
Update README.md (#265)
Browse files Browse the repository at this point in the history
  • Loading branch information
timotheeguerin authored Aug 13, 2024
1 parent c1c6844 commit dadbd00
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,16 @@ chronus goal is to provide changelog management. It was heavily inspired by [cha
- Checking for changes are done by comparing the remote instead of the local base branch. This solve the issue where you might have merged the base branch into your feature branch but not into the local main branch and changesets would report lots of unrelated change.
- Verify checks every packages have changelog not just that we have a single changelog file.
- Different versioning policies than changesets. LockedStep provide a way to say we will only ever bump the version by the single specified step at everyrelease. This is a way to diverge from true semver where you might release major changes in minor version.(Particularly useful in pre-release `0.x` where minor versions can be used to release breaking changes)
- Design to be able to plug in different monorepo(changesets also does that), source control system as a plugin system(only git added but left room for more).
- Designed to be able to plug in different monorepo(changesets also does that), source control system as a plugin system(only git added but left room for more).
- Change can be defined in custom categories that allow more meaningful grouping of changes in the changelog. See [Change kinds doc](./docs/change-kinds.md)
- Nightly builds

## Documentation

- [CLI](./docs/cli.md)

Chronus functionalities:

- [Configure change kinds](./docs/change-kinds.md) _Use a different set of change kinds from `major`, `minor`, `patch`_
- [Filter files needing changelogs](./docs/changed-files-filter.md) _Ignore certain files from needing a changelog entry_
[Docs](./docs/readme.md)

## Develop

- [CLI](./docs/cli.md)

Chronus functionalities:

- [Configure change kinds](./docs/change-kinds.md) _Use a different set of change kinds from `major`, `minor`, `patch`_

### Requirements

- Node LTS
Expand Down
3 changes: 3 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
Chronus functionalities:

- [Configure change kinds](change-kinds.md) _Use a different set of change kinds from `major`, `minor`, `patch`_
- [Changed files filter](changed-files-filter.md)
- [Configure changelog generator](changelog-generator.md)
- [Prereleases](prerelease.md)
- [Version policies](version-policies.md)

0 comments on commit dadbd00

Please sign in to comment.