From e501df8ab1ac4d4efb2b15aaa8cbd9e30cc1aaa7 Mon Sep 17 00:00:00 2001 From: David Dal Busco Date: Fri, 22 Sep 2023 08:53:52 +0200 Subject: [PATCH] docs: npm flags --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index d0f7568..8585729 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ # tsdoc-markdown +
+ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/tsdoc-markdown?style=flat-square +[npm-badge-url]: https://www.npmjs.com/package/tsdoc-markdown +[npm-license]: https://img.shields.io/npm/l/tsdoc-markdown?style=flat-square +[npm-license-url]: https://github.com/buildwithjuno/juno-js/blob/main/LICENSE + [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-) +
+ Generates markdown documentation from TypeScript source code. Useful for generating docs from code and injecting automatically the outcome into project README files. ## :1234: Table of contents