From 67503c7b3df4e1dcf5dab2a5e1ae0db45db974ad Mon Sep 17 00:00:00 2001
From: Aleksandr Razumov <ar@gortc.io>
Date: Sun, 26 Apr 2020 19:40:37 +0300
Subject: [PATCH] readme: improve

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1694dff..3e4f7fa 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,25 @@
 # golangci-lint-action
 
-Work in progress
+![docker image](https://github.com/golangci/golangci-lint-action/workflows/docker%20image/badge.svg)
+
+Action that runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
+
+You can put `.github/workflows/lint.yml` with following contents:
+```yaml
+name: golangci
+on: [push]
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v1
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v0.0.2
+        with:
+          github_token: ${{ secrets.github_token }}
+
+```
 
 Based on [reviewdog action](https://github.com/reviewdog/action-golangci-lint).