From dadbd003c2ab1d4de1b261c32a453b78c0a5aabf Mon Sep 17 00:00:00 2001 From: Timothee Guerin Date: Tue, 13 Aug 2024 10:59:47 -0700 Subject: [PATCH] Update README.md (#265) --- README.md | 16 +++------------- docs/readme.md | 3 +++ 2 files changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c3839047..193704cf 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/readme.md b/docs/readme.md index f6d76f01..454373d0 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -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)