Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leerob committed Feb 12, 2022
1 parent a8d2a49 commit 145a816
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@
<img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=vercel&labelColor=000000&logoWidth=20">
</a>

[![Build Status](https://circleci.com/gh/vercel/release.svg?&style=shield)](https://circleci.com/gh/vercel/release)
[![Join the community on GitHub Discussions](https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=vercel&labelColor=000000&logoWidth=20)](https://github.com/vercel/vercel/discussions)

When run, this command line interface automatically generates a new [GitHub Release](https://help.github.com/articles/creating-releases/) and populates it with the changes (commits) made since the last release.
Release is a command line tool to automatically generate a new [GitHub Release](https://help.github.com/articles/creating-releases/) and populates it with the changes (commits) made since the last release.

## Usage

Firstly, install the package from [npm](https://npmjs.com/release) (you'll need at least Node.js 7.6.0):
Firstly, install the package from [npm](https://npmjs.com/release):

```bash
npm install -g release
Expand All @@ -29,7 +26,7 @@ Once that's done, you can run this command inside your project's directory:
release <type>
```

As you can see, a `<type>` argument can be passed. If you leave it out, a [GitHub Release](https://help.github.com/articles/creating-releases/) will be created from the most recent commit and tag.
A `<type>` argument can be passed. If you leave it out, a [GitHub Release](https://help.github.com/articles/creating-releases/) will be created from the most recent commit and tag.

According to the [SemVer](https://semver.org) spec, the argument can have one of these values:

Expand Down Expand Up @@ -118,4 +115,4 @@ Thanks a lot to [Daniel Chatfield](https://github.com/danielchatfield) for donat

## Author

Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [Vercel](https://vercel.com)
Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo))

0 comments on commit 145a816

Please sign in to comment.