Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
DavidVollmers committed May 7, 2024
1 parent 65f4e00 commit 0822e2c
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -9,16 +9,14 @@
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.
JSON, and more.

## Getting Started

Install the `doki` Command-Line Interface:

```bash
dotnet tool install --global Doki.CommandLine --version 0.3.0-preview
dotnet tool install --global Doki.CommandLine --version 0.4.0-preview
```

> **Note:** You can find the latest version of the CLI and how to install it

0 comments on commit 0822e2c

Please sign in to comment.