Skip to content

Commit

Permalink
docs: update readme todo
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdehaven committed May 7, 2024
1 parent a288f08 commit 3f748fe
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Kong Markdown

> [!IMPORTANT]
> This repository and the `@kong/markdown` package are currently in development on the `main` branch. Breaking changes should be expected.
Kong's open-source markdown renderer and live editor.

- [TODO](#todo)
Expand All @@ -22,6 +19,8 @@ Kong's open-source markdown renderer and live editor.

## TODO

Currently, the package size is... HUGE. This is due to packaging the syntax highlighter lib along with Mermaid support. In the future, this will be optimized and/or externalized.

- [ ] Optimize exports via separate bundles for syntax highlighting options

## Usage
Expand Down

0 comments on commit 3f748fe

Please sign in to comment.