Skip to content

Commit

Permalink
updated home readme (changesets#118)
Browse files Browse the repository at this point in the history
* updated home readme

We have never perfected the selling of changesets - even when we think it's awesome, we struggle to tell people why. (the fact that I always tell people what it does, not what problems it solves wasn't helping)

I'm trying to fix that, and make a reference to help me fix it when talking to other people in the future.

This work is inspired by me being fed-up with this problem.

Co-Authored-By: Mitchell Hamilton <[email protected]>
  • Loading branch information
Noviny and emmatown authored Jul 15, 2019
1 parent cc35740 commit 9d0cb88
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,29 @@
# 🦋 changesets 🦋

> A way to manage your versioning and changelogs with a focus on mono-repos
> A way to manage your versioning and changelogs with a focus on multi-package repositories
## Less concepts, more how-to-get-started
The `changesets` workflow is designed to help from when people are making changes, all the way through to publishing. It lets contributors declare how their changes should be released, then we automate updating package versions, and changelogs, and publishing new versions of packages based on the provided information.

Changesets has a focus on solving these problems for multi-package repositories, and keeps packages that rely on each other within the multi-package repository up-to-date, as well as making it easy to make changes to groups of packages.

## How do we do that?

A `changeset` is an intent to release a set of packages at particular [semver bump types](https://semver.org/) with a summary of the changes made.

The **@changesets/cli** package allows you to write `changeset` files as you make changes, then combine any number of changesets into a release, that flattens the bump-types into a single release per package, handles internal dependencies in a multi-package-repository, and updates changelogs, as well as release all updated packages from a mono-repository with one command.

## How do I get started?

If you just want to jump in to using changesets, the [@changesets/cli](./packages/cli/README.md) docs are where you should head.

If you want a detailed explanation of the the concepts behind changesets, or to understand how you would build on top
of changesets, check out our [detailed-explanation](./docs/detailed-explanation.md)

We also have a [spec](./docs/spec.md)

# Thanks/Inspiration

- [bolt](https://github.com/boltpkg/bolt) - Brought us a strong concept of how packages in a mono-repo should be able to interconnect, and provided the initial infrastructure to get inter-package information.
- [atlaskit](https://atlaskit.atlassian.com) - The original home of the changesets code, and where many of the ideas and processes were fermented.
- [lerna-semantic-release](https://github.com/atlassian/lerna-semantic-release) - put down many of the initial patterns around updating packages within a multi-package-repository, and started us thinking about how to manage dependent packages.
- [Thinkmill](https://www.thinkmill.com.au) - For sponsoring the focused open sourcing of this project, and the version two rearchitecture

0 comments on commit 9d0cb88

Please sign in to comment.