Skip to content

Commit

Permalink
small docs improvement (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
Noviny committed Jul 17, 2019
1 parent 9d0cb88 commit 6f8eb05
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .changeset/nervous-elephants-fry/changes.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"releases": [{ "name": "@changesets/cli", "type": "patch" }],
"dependents": []
}
1 change: 1 addition & 0 deletions .changeset/nervous-elephants-fry/changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated readme
6 changes: 4 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ The primary implementation of [changesets](https://github.com/Noviny/changesets)
and changelog entries for your packages, with a focus on versioning within a mono-repository (though we support
single-package repositories too).

This package is intended as a successor to `@atlaskit/build-releases` with a more general focus.
This package is intended as a successor to `@atlaskit/build-releases` with a more general focus. It works in
[bolt](https://www.npmjs.com/package/bolt) multi-package repositories, [yarn workspaces] multi-package repositories, and
in single-package repositories.

## Getting Started

Expand Down Expand Up @@ -36,7 +38,7 @@ Below you can find a basic workflow for maintainers to help them use changesets,

The core concept that `changesets` follows is that contributors to a repository should be able to declare an intent to release, and that multiple intents should be able to be combined sensibly. Sensibly here refers to if there is one intent to release button as a 'minor' and another to release button as a 'patch', only one release will be made, at the higher of the two versions.

A single `changeset` is an intent to release stored as data, with the information we need to combine multiple changesets and coordinate releases. We also work along bolt's structure guidelines to make sure that packages within a mono-repository will all depend on the latest versions of each other. This approach comes from [bolt](https://www.npmjs.com/package/bolt).
A single `changeset` is an intent to release stored as data, with the information we need to combine multiple changesets and coordinate releases. It will also update internal dependencies within a multi-package repository.

## Base workflow

Expand Down

0 comments on commit 6f8eb05

Please sign in to comment.