From ac29160f3e4bbd083512550069260eab8129e376 Mon Sep 17 00:00:00 2001 From: jaedle Date: Fri, 1 Mar 2019 15:10:34 +0100 Subject: [PATCH] add linting for markdown --- .travis.yml | 1 + README.md | 24 ++++++++++++++++-------- Taskfile.yml | 5 +++++ 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index 5f3fc80..af27d12 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,5 +22,6 @@ script: - task test - task integration-test - task lint +- task lint-markdown - task coveralls-analysis - task sonar-analysis diff --git a/README.md b/README.md index b557317..e2509cd 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,10 @@ Yet another tp-link HS100 library for golang ## Usage -install library ``go get github.com/jaedle/golang-tplink-hs100`` +install library `go get github.com/jaedle/golang-tplink-hs100` -use the following code as main and replace `YOUR_HS100_DEVICE` with the address of your HS100-device. +use the following code as main and replace `YOUR_HS100_DEVICE` with the +address of your HS100-device. ```golang package main @@ -42,18 +43,25 @@ func main() { ## Acknowledgements -- [tplink-smarthome-api](https://github.com/plasticrake/tplink-smarthome-api): Thanks for the inspiration! -- [tplink-smarthome-crypto](https://github.com/plasticrake/tplink-smarthome-crypto) Thanks for the excellent documentation/test-cases for encrypting/decrypting the communication -- [tplink-smarthome-simulator](https://github.com/plasticrake/tplink-smarthome-simulator) Thanks for providing a device simulator for integration tests! -- [hs1xxplug](https://github.com/sausheong/hs1xxplug): Thanks for the blueprint in golang! +- [tplink-smarthome-api](https://github.com/plasticrake/tplink-smarthome-api): + Thanks for the inspiration! +- [tplink-smarthome-crypto](https://github.com/plasticrake/tplink-smarthome-crypto) + Thanks for the excellent documentation/test-cases for encrypting/decrypting + the communication + +- [tplink-smarthome-simulator](https://github.com/plasticrake/tplink-smarthome-simulator) + Thanks for providing a device simulator for integration tests! + +- [hs1xxplug](https://github.com/sausheong/hs1xxplug): + Thanks for the blueprint in golang! ## Development ### Prerequisites -1. go-task -2. docker +1. go-task +1. docker ## Project structure diff --git a/Taskfile.yml b/Taskfile.yml index b1bbebb..419d101 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -53,6 +53,11 @@ tasks: silent: true cmds: - golangci-lint run + lint-markdown: + dir: ./ + silent: true + cmds: + - docker container run --rm -it -v "$PWD/README.md:/lint/input/README.md" zemanlx/remark-lint --quiet --frail README.md --no-stdout coveralls-analysis: silent: true cmds: