diff --git a/README.md b/README.md index b01dbb1..93b9561 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,12 @@ # doki -> A modern .NET Documentation Framework +Doki is a .NET code documentation framework that allows you to generate documentation from your codebase. + +It uses the XML documentation comments in your code to generate documentation in various formats, such as Markdown, +Blazor, and more. + +> **Note:** Doki is still in preview. Currently, only the Markdown output is available. ## Getting Started diff --git a/src/Doki/Doki.csproj b/src/Doki/Doki.csproj index 8fa6b91..e05a41e 100644 --- a/src/Doki/Doki.csproj +++ b/src/Doki/Doki.csproj @@ -4,7 +4,7 @@ Doki david@vollmers.org David Vollmers - A modern .NET Documentation Framework + A modern .NET Code Documentation Framework https://github.com/DavidVollmers/doki MIT README.md