docs

DavidVollmers · Apr 21, 2024 · a75d0b8 · a75d0b8
1 parent 8f781fc
commit a75d0b8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -4,7 +4,7 @@
         <PackageId>Doki</PackageId>
         <Authors>david@vollmers.org</Authors>
         <Copyright>David Vollmers</Copyright>
-        <Description>A modern .NET Documentation Framework</Description>
+        <Description>A modern .NET Code Documentation Framework</Description>
         <PackageProjectUrl>https://github.com/DavidVollmers/doki</PackageProjectUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageReadmeFile>README.md</PackageReadmeFile>