Permalink
Browse files

update readme

  • Loading branch information...
kamilsk committed Sep 22, 2018
1 parent 26df729 commit f048ce2db01f0f114f134d55c3fef64aab3b7f9c
Showing with 51 additions and 37 deletions.
  1. +51 −37 README.md
@@ -1,12 +1,20 @@
> # check [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20Something%20as%20a%20Service&url=https://github.com/kamilsk/check&via=ikamilsk&hashtags=go,tool,website-audit)
> [![Analytics](https://ga-beacon.appspot.com/UA-109817251-19/check/readme?pixel)](https://github.com/kamilsk/check)
> # 🔬 check [![Tweet][icon_twitter]][twitter_publish]
> [![Analytics][analytics_pixel]][page_promo]
> Check Something as a Service.
[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/octolab)
[![Build Status](https://travis-ci.org/kamilsk/check.svg?branch=master)](https://travis-ci.org/kamilsk/check)
[![Code Coverage](https://scrutinizer-ci.com/g/kamilsk/check/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/kamilsk/check/?branch=master)
[![Code Quality](https://scrutinizer-ci.com/g/kamilsk/check/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/kamilsk/check/?branch=master)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Patreon][icon_patreon]](https://www.patreon.com/octolab)
[![Build Status][icon_build]][page_build]
[![Code Coverage][icon_coverage]][page_quality]
[![Code Quality][icon_quality]][page_quality]
[![Research][icon_research]](../../tree/research)
[![License][icon_license]](LICENSE)

## Roadmap

- [x] v1: MVP
- [ ] v2: check redirects
- [ ] v3: check repositories
- [ ] v4: check packages

## Usage

@@ -58,6 +66,16 @@ Flags:
Use "check [command] --help" for more information about a command.
```

#### Bash and Zsh completions

You can find completion files [here](https://github.com/kamilsk/shared/tree/dotfiles/bash_completion.d) or
build your own using these commands

```bash
$ check completion bash > /path/to/bash_completion.d/check.sh
$ check completion zsh > /path/to/zsh-completions/_check.zsh
```

## Installation

### Brew
@@ -69,53 +87,49 @@ $ brew install kamilsk/tap/check
### Binary

```bash
$ export VER=1.0.0 # all available versions are on https://github.com/kamilsk/check/releases
$ export REQ_VER=1.0.0 # all available versions are on https://github.com/kamilsk/check/releases
$ export REQ_OS=Linux # macOS and Windows are also available
$ export REQ_ARCH=64bit # 32bit is also available
$ wget -q -O check.tar.gz \
https://github.com/kamilsk/check/releases/download/"${VER}/check_${VER}_${REQ_OS}-${REQ_ARCH}".tar.gz
$ # wget -q -O check.tar.gz
$ curl -sL -o check.tar.gz \
https://github.com/kamilsk/check/releases/download/"${REQ_VER}/check_${REQ_VER}_${REQ_OS}-${REQ_ARCH}".tar.gz
$ tar xf check.tar.gz -C "${GOPATH}"/bin/ && rm check.tar.gz
```

### From source code

```bash
$ egg github.com/kamilsk/check@^1.0.0 -- make test install
```

#### Mirror

```bash
$ # or use mirror
$ egg bitbucket.org/kamilsk/check@^1.0.0 -- make test install
```

> [egg](https://github.com/kamilsk/egg) is an `extended go get`.
> [egg](https://github.com/kamilsk/egg)<sup id="anchor-egg">[1](#egg)</sup> is an `extended go get`.
### Bash and Zsh completions
<sup id="egg">1</sup> The project is still in prototyping. [](#anchor-egg)

You can find completion files [here](https://github.com/kamilsk/shared/tree/dotfiles/bash_completion.d) or
build your own using these commands
---

```bash
$ check completion bash > /path/to/bash_completion.d/check.sh
$ check completion zsh > /path/to/zsh-completions/_check.zsh
```
[![@kamilsk][icon_tw_author]](https://twitter.com/ikamilsk)
[![@octolab][icon_tw_sponsor]](https://twitter.com/octolab_inc)

## Notes
made with ❤️ by [OctoLab](https://www.octolab.org/)

- brief roadmap
- [x] v1: MVP
- [ ] v2: check redirects
- [ ] v3: check repository
- [ ] v4: check package
- [ ] v5: distributed run
- [ ] integrate with Status, SaaS
- [research](../../tree/research)
- tested on Go 1.8, 1.9 and 1.10
[analytics_pixel]: https://ga-beacon.appspot.com/UA-109817251-19/check/readme?pixel

---
[icon_build]: https://travis-ci.org/kamilsk/check.svg?branch=master
[icon_coverage]: https://scrutinizer-ci.com/g/kamilsk/check/badges/coverage.png?b=master
[icon_gitter]: https://badges.gitter.im/Join%20Chat.svg
[icon_license]: https://img.shields.io/badge/license-MIT-blue.svg
[icon_patreon]: https://img.shields.io/badge/patreon-donate-orange.svg
[icon_quality]: https://scrutinizer-ci.com/g/kamilsk/check/badges/quality-score.png?b=master
[icon_research]: https://img.shields.io/badge/research-in%20progress-yellow.svg
[icon_tw_author]: https://img.shields.io/badge/author-%40kamilsk-blue.svg
[icon_tw_sponsor]: https://img.shields.io/badge/sponsor-%40octolab-blue.svg
[icon_twitter]: https://img.shields.io/twitter/url/http/shields.io.svg?style=social

[![@kamilsk](https://img.shields.io/badge/author-%40kamilsk-blue.svg)](https://twitter.com/ikamilsk)
[![@octolab](https://img.shields.io/badge/sponsor-%40octolab-blue.svg)](https://twitter.com/octolab_inc)
[page_build]: https://travis-ci.org/kamilsk/check
[page_promo]: https://github.com/kamilsk/check
[page_quality]: https://scrutinizer-ci.com/g/kamilsk/check/?branch=master

made with ❤️ by [OctoLab](https://www.octolab.org/)
[twitter_publish]: https://twitter.com/intent/tweet?text=Check%20Something%20as%20a%20Service&url=https://github.com/kamilsk/check&via=ikamilsk&hashtags=go,tool,website-audit

0 comments on commit f048ce2

Please sign in to comment.