diff --git a/README.md b/README.md index ec7e13db..5115766b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Kong Markdown > [!IMPORTANT] -> This repository and the `@kong/markdown` package are currently in development. Breaking changes should be expected. +> This repository and the `@kong/markdown` package are currently in development on the `alpha` branch. Breaking changes should be expected. Kong's open-source markdown renderer and live editor. @@ -19,13 +19,12 @@ Kong's open-source markdown renderer and live editor. ## TODO -- [ ] Utilize design tokens -- [ ] Add new icons for toolbar -- [ ] Possibly export a separate bundle as a web component utilizing [petite-vue](https://github.com/vuejs/petite-vue) +- [X] Utilize design tokens +- [X] Add new icons for toolbar +- [ ] Possibly export separate bundles for syntax highlighting options - [ ] Document theming instructions - [ ] Light / Dark mode -- [ ] Default `shikiji` theme(s) -- [ ] Supported languages (instead of allowing all) +- [ ] Default styles for markdown HTML elements ## Usage