add linting for markdown

jaedle · Mar 1, 2019 · ac29160 · ac29160
1 parent b303155
commit ac29160
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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: