diff --git a/README.md b/README.md index 0e813a3..89ac450 100644 --- 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