docs(compodoc): add kudos to @compodoc

twittwer · May 2, 2020 · 7c9cbf1 · 7c9cbf1
1 parent c987daa
commit 7c9cbf1
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/libs/compodoc/README.md b/libs/compodoc/README.md
@@ -1,10 +1,11 @@
-# compodoc
+# Compodoc (Nx Plugin)
 
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
 [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
-> Nx Plugin to integrate the generation of documentation with [Compodoc](https://compodoc.app/) in the [Nx workflow](https://nx.dev/angular).
+> Nx Plugin to integrate the generation of documentation with [Compodoc](https://compodoc.app/) in the [Nx workflow](https://nx.dev/angular).  
+> NOTE: The whole generation part is done by [@compodoc/compodoc](https://github.com/compodoc/compodoc), this is just a wrapper plugin for Nx workspaces.
 
 - [Installation](#installation)
 - [Usage](#usage)