diff --git a/.changeset/rude-jeans-explain.md b/.changeset/rude-jeans-explain.md new file mode 100644 index 0000000..9a81d55 --- /dev/null +++ b/.changeset/rude-jeans-explain.md @@ -0,0 +1,5 @@ +--- +"@studiocms/markdown-remark": patch +--- + +update readme diff --git a/README.md b/README.md deleted file mode 100644 index c7c4e3b..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# StudioCMS Markdown Remark - -Read more in the [package README](./packages/markdown-remark/README.md) \ No newline at end of file diff --git a/README.md b/README.md new file mode 120000 index 0000000..5645d94 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +packages/markdown-remark/README.md \ No newline at end of file diff --git a/packages/markdown-remark/README.md b/packages/markdown-remark/README.md index 04108cb..546ca60 100644 --- a/packages/markdown-remark/README.md +++ b/packages/markdown-remark/README.md @@ -1,5 +1,9 @@ # @studiocms/markdown-remark +[![NPM Version](https://img.shields.io/npm/v/@studiocms/markdown-remark?style=for-the-badge&logo=npm)](https://npm.im/@studiocms/markdown-remark) +[![Formatted with Biome](https://img.shields.io/badge/Formatted_with-Biome-60a5fa?style=for-the-badge&logo=biome)](https://biomejs.dev/) +[![Built with Astro](https://img.shields.io/badge/built_with-astro-astro?style=for-the-badge&logo=astro&logoColor=fff&color=%23BC52EE)](https://astro.build) + ## Overview `@studiocms/markdown-remark` is a powerful Markdown parser and transformer built on top of [remark](https://github.com/remarkjs/remark). It provides seamless integration with [Astro](https://astro.build/), allowing you to easily parse and transform Markdown content within your Astro projects. @@ -155,4 +159,16 @@ const content = await render("# Hello World!") {content.html} -``` \ No newline at end of file +``` + +## Changelog + +See the [Changelog](https://github.com/withstudiocms/markdown-remark/blob/main/packages/markdown-remark/CHANGELOG.md) for the change history of this package. + +## Contribution + +If you see any errors or room for improvement, feel free to open an [issue or pull request](https://github.com/withstudiocms/markdown-remark/) . Thank you in advance for contributing! ❤️ + +## Licensing + +[MIT Licensed](./LICENSE). \ No newline at end of file