diff options
| author | Jakub Jirutka <jakub@jirutka.cz> | 2018-01-30 19:09:28 +0100 |
|---|---|---|
| committer | Jakub Jirutka <jakub@jirutka.cz> | 2018-01-30 19:41:49 +0100 |
| commit | e31363712395052ba7228270d976f7ba08927246 (patch) | |
| tree | 42802507c1ce4186412ab1bf42b3d0839f60f7b9 | |
| parent | d1240b1f6d706cb985c32cd0a20800c758ca930c (diff) | |
Readme: Add Usage
| -rw-r--r-- | README.adoc | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/README.adoc b/README.adoc index 8a7f929..d0aceba 100644 --- a/README.adoc +++ b/README.adoc @@ -33,7 +33,17 @@ gem install {gem-name} --pre == Usage -TODO +Just `require '{gem-name}'`. +If you invoke Asciidoctor from command-line, use option `-r` to load the extension: + +[source, subs="+attributes"] +asciidoctor -r {gem-name} README.adoc + +If you don’t want the extension to be automatically registered in Asciidoctor, don’t _require_ `{gem-name}`, but `asciidoctor/interdoc_reftext/processor`. + +IMPORTANT: Bundler automatically _requires_ all the specified gems. + To prevent it, use + + `gem '{gem-name}', require: false`. == License |