update docs (#22)

This commit is contained in:
Andrew Mason 2019-10-28 20:55:51 -04:00 committed by GitHub
parent 715d4ecef7
commit d90d717965
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 22 deletions

View File

@ -5,17 +5,6 @@
"imageSize": 100, "imageSize": 100,
"commit": false, "commit": false,
"contributors": [ "contributors": [
{
"login": "MiguelSavignano",
"name": "Miguel Savignano",
"avatar_url": "https://avatars3.githubusercontent.com/u/6641863?v=4",
"profile": "https://github.com/MiguelSavignano",
"contributions": [
"infra",
"test",
"code"
]
},
{ {
"login": "andrewmcodes", "login": "andrewmcodes",
"name": "Andrew Mason", "name": "Andrew Mason",
@ -27,6 +16,17 @@
"doc", "doc",
"code" "code"
] ]
},
{
"login": "MiguelSavignano",
"name": "Miguel Savignano",
"avatar_url": "https://avatars3.githubusercontent.com/u/6641863?v=4",
"profile": "https://github.com/MiguelSavignano",
"contributions": [
"infra",
"test",
"code"
]
} }
], ],
"contributorsPerLine": 7, "contributorsPerLine": 7,

View File

@ -13,3 +13,4 @@ Explain value.
## Checklist ## Checklist
- [ ] My code follows the style guidelines of this project - [ ] My code follows the style guidelines of this project
- [ ] Actions are passing

View File

@ -1,10 +1,10 @@
![rubocop linter actions banner](screenshots/rubocop-linter-action.png) ![Rubocop](https://github.com/andrewmcodes/rubocop-linter-action/workflows/Rubocop/badge.svg)
![Tests](https://github.com/andrewmcodes/rubocop-linter-action/workflows/Test/badge.svg)
![Version Number](https://img.shields.io/static/v1?label=Version&message=v0.2.0&color=blue)
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors) [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)
# Rubocop Linter Action # Rubocop Linter Action
![version number](https://img.shields.io/static/v1?label=Version&message=v0.2.0&color=blue)
GitHub Action to run Rubocop against your code and create annotations in the UI. GitHub Action to run Rubocop against your code and create annotations in the UI.
**NOTE: due to the GitHub Check Runs API, we can only return 50 annotations per run. See [here](https://developer.github.com/v3/checks/runs/#output-object) for more info.** **NOTE: due to the GitHub Check Runs API, we can only return 50 annotations per run. See [here](https://developer.github.com/v3/checks/runs/#output-object) for more info.**
@ -25,13 +25,7 @@ Add the following to your GitHub action workflow:
```yaml ```yaml
name: Rubocop name: Rubocop
on: on: [push]
pull_request:
branches:
- '*'
push:
branches:
- master
jobs: jobs:
build: build:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB