Skip to content

Commit

Permalink
docs: clean up README for initial prototype
Browse files Browse the repository at this point in the history
  • Loading branch information
mroth committed May 7, 2019
1 parent 801f080 commit 2a4661a
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,34 @@ Doing this:
Afterwards you have a local checkout of the repository, you may wish to do `git
fetch` to pull all remote tags to your system. :eyes:

# Installation
:warning:
<small>
_Pre-release software! API or even the package name might change (Any
better ideas for the name btw?)_
</small>

Download from the [Releases page](https://github.com/mroth/bump/releases) and
put somewhere in your `$PATH.`

macOS Homebrew users can `brew install mroth/formulas/bump`.

# Comparison

Unlike ***, bump is currently intended to support workflows where rather than ***
Unlike many of these release tools, bump is currently intended to support
workflows where rather than pushing tags locally, new releases are primarily
drafted via the Github Releases web interface (all the easier to drag your animated
GIFs in, and whatnot.)

This may not be the correct workflow for your project! In particular, it really
works best in environments where there is not a version number file that stored
in version control itself (Node NPM, Rust Cargo), but rather those where the git
tags themselves manage the versioning (Go modules libraries, sbt-git, etc.)

Some other tools I found in looking at this
Some related tools I found in looking at this you may wish to consider as alternatives.

* [sindresorhus/np] For NPM projects, this is really good. We've adopted it for all our JS native projects at @openlawteam, in conjunction with `--no-publish`.
* [goreleaser] FOO BAR ****
* [goreleaser] For Go projects, this tool is super good. In fact, it works well in partnership with `bump`, the two tools can be complimentary for certain workflows (and I use goreleaser to package bump itself!).
* [zeit/release] Very close to what we wanted, but it does the tag/commit locally and pushes to GitHub before drafting the release, and requires API authorization to draft the release message.

[sindresorhus/np]: https://github.com/sindresorhus/np
Expand Down

0 comments on commit 2a4661a

Please sign in to comment.