Skip to content

Commit

Permalink
Merge pull request #1 from reviewdog/README.md
Browse files Browse the repository at this point in the history
Add README
  • Loading branch information
haya14busa authored May 6, 2020
2 parents aba9c48 + 4ac34da commit 4491a41
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 haya14busa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# reviewdog nightly releases
[![release](https://github.com/reviewdog/nightly/workflows/release/badge.svg)](https://github.com/reviewdog/nightly/actions?query=workflow%3Arelease)
[![release page](https://img.shields.io/github/release/reviewdog/nightly.svg?logo=github)](https://github.com/reviewdog/nightly/releases)
<!--
[![release stat](https://img.shields.io/github/downloads/reviewdog/nightly/total.svg?logo=github)](https://somsubhra.com/github-release-stats/?username=reviewdog&repository=nightly)
-->

It provides nightly [reviewdog](https://github.com/reviewdog/reviewdog) releases.
You'll get to try the latest reviwedog improvements every day.

Your feedback will support reviewdog maintainance, so I hope you'll consider
trying the reviewdog nightly and give us any feedback!
Please [file an issue](https://github.com/reviewdog/reviewdog/issues) if you come across any bugs.

## Install nightly reviewdog

```shell
# Install the latest version. (Install it into ./bin/ by default).
$ curl -sfL https://raw.githubusercontent.com/reviewdog/nightly/master/install.sh| sh -s

# Specify installation directory ($(go env GOPATH)/bin/)
$ curl -sfL https://raw.githubusercontent.com/reviewdog/nightly/master/install.sh| sh -s -- -b $(go env GOPATH)/bin

# In alpine linux (as it does not come with curl by default)
$ wget -O - -q https://raw.githubusercontent.com/reviewdog/nightly/master/install.sh| sh -s [vX.Y.Z]
```

You can check installed version and +build commit short hash with `reviewdog -version`.

```shell
$ ./bin/reviewdog --version
0.9.17-nightly20200506+f536e33
```

0 comments on commit 4491a41

Please sign in to comment.