From 2b00887556fbf0be212885486e11a1af6360f921 Mon Sep 17 00:00:00 2001 From: Michael Billington Date: Sat, 3 Jun 2017 21:18:20 +1000 Subject: [PATCH] update README --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4f6ab74..12a2e3b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Practical CI testing for markdown files. -## Installation +## Dependencies Requirements: @@ -10,18 +10,27 @@ Requirements: - xmllint - pandoc +## Installation + ```bash -git clone https://github.com/mike42/mdcheckr -cp mdcheckr/mdcheckr /usr/local/bin +curl https://raw.githubusercontent.com/mike42/mdcheckr/master/mdcheckr -o mdcheckr +chmod +x mdcheckr +sudo cp mdcheckr /usr/local/bin ``` ## Usage -Check a single markdown file +Check a single markdown file: + +``` +mdcheckr README.md +``` Check all the markdown files in the current directory: +``` find . -name '*.md' -print0 | xargs -0 mdcheckr +``` Check all the markdown files in your Git repository: