added another notice

2025-10-23 22:17:40 +02:00
parent 13e56f057b
commit 96d200888a
1 changed files with 4 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -8,10 +8,13 @@

 ![screencast](.gitlab/screencast.gif)

-Docki is cli for converting asciidoctor files into html files. You can build your documentation with `docki build` and write documenation using the live server with `docki serve`.
+Docki is cli for converting asciidoctor files into html files.

 ## Usage

+> [!NOTE]
+> This works in a directory with a directory called `docs`, which contains the asciidoctor documentation.
+
 ### Building the documentation

 ```shell