From 371cfa47267f584a3df221ef6b775b6e44417828 Mon Sep 17 00:00:00 2001 From: Gaurav Nelson Date: Wed, 2 Aug 2017 10:35:38 +1000 Subject: [PATCH] Update README.adoc --- README.adoc | 55 +++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/README.adoc b/README.adoc index 6f51ddb..288d5e2 100644 --- a/README.adoc +++ b/README.adoc @@ -1,19 +1,41 @@ = asciidoc-link-check Checks if all hyperlinks in an asciidoc file are alive(or dead). -(Uses most of the source code from https://github.com/tcort/markdown-link-check[markdown-link-check] module) +(Uses the source code from https://github.com/tcort/markdown-link-check[markdown-link-check] module) -== Installation -To add the module to your project, run: +== Local Installation +To install the command line tool, run: [source, bash] ---- -npm install --save asciidoc-link-check +npm install -g asciidoc-link-check +---- + +=== Usage +(Optional) Use the `-p` or `--progress` switch to view progress. + +==== Check links for a local file +[source,bash] +---- +asciidoc-link-check README.adoc --progress +---- + +==== Check links for an online file +[source,bash] +---- +asciidoc-link-check https://github.com/gaurav-nelson/asciidoc-link-check/blob/master/README.adoc +---- + +==== Check links from standard input +[source,bash] +---- +cat *.adoc | asciidoc-link-check -p ---- -To install the command line tool globally, run: +=== Using in your node project +To add the module to your project, run: [source, bash] ---- -npm install -g asciidoc-link-check +npm install --save asciidoc-link-check ---- == API @@ -43,24 +65,3 @@ asciidocLinkCheck('xref:https://www.google.com[Google]', function (err, results) }); }); ---- - -=== Command Line -(Optional) Use the `-p` or `--progress` switch to view progress. - -==== Check links for a local file -[source,bash] ----- -asciidoc-link-check README.adoc --progress ----- - -==== Check links for an online file -[source,bash] ----- -asciidoc-link-check https://github.com/gaurav-nelson/asciidoc-link-check/blob/master/README.adoc ----- - -==== Check links from standard input -[source,bash] ----- -cat *.adoc | asciidoc-link-check -p -----