diff --git a/README.adoc b/README.adoc index a77b97e..7112022 100644 --- a/README.adoc +++ b/README.adoc @@ -16,7 +16,18 @@ :uri-asciidoc: http://asciidoc.org/ :uri-termcolor: https://termcolor.readthedocs.io/ -*{project}* is a search tool for EPUB e-books. +:license: https://schlomp.space/tastytea/{project}/src/branch/main/LICENSE +:license-termcolor: https://schlomp.space/tastytea/{project}/src/branch/main/dist/termcolor/LICENSE + +*{project}* is a search tool for EPUB e-books. It does not operate on lines, but +on whole files. All newlines will be replaced by spaces and HTML will be +stripped. This means you can search for text spanning multiple lines and don't +have to worry about HTML tags in the text. + +{project} is licensed under the +link:{license}[AGPL-3.0-only] +license. The bundled link:{uri-termcolor}[Termcolor] is licensed under the +link:{license-termcolor}[BSD-3-Clause] license. == Usage diff --git a/man/epubgrep.1.adoc b/man/epubgrep.1.adoc index aa2944b..abc004a 100644 --- a/man/epubgrep.1.adoc +++ b/man/epubgrep.1.adoc @@ -2,7 +2,7 @@ :doctype: manpage :Author: tastytea :Email: tastytea@tastytea.de -:Date: 2021-05-24 +:Date: 2021-05-25 :Revision: 0.0.0 :man source: epubgrep :man manual: General Commands Manual @@ -68,10 +68,11 @@ before>. and may not be avai === Differences to grep -epubgrep does not operate on lines, but on whole files. This means you can -search for text spanning multiple lines. All newlines will be replaced by spaces -and HTML will be stripped. Use *--raw* if you want to search in the raw files -instead. +epubgrep does not operate on lines, but on whole files. All newlines will be +replaced by spaces (multiple newlines will be condensed into one space) and HTML +will be stripped. This means you can search for text spanning multiple lines and +don't have to worry about HTML tags in the text. Use *--raw* if you want to +search in the raw files instead. === Configuration