From 99ff81d42c70e4896b261cc106e3f201fe3f018f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mar=C3=ADa=20Valderrama?= <mavalroot@gmail.com>
Date: Tue, 17 Sep 2024 14:36:01 +0200
Subject: [PATCH] feat(api-doc): update readme

---
 libs/plugin-types/README.md | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/libs/plugin-types/README.md b/libs/plugin-types/README.md
index d9af74d3..a23f2d26 100644
--- a/libs/plugin-types/README.md
+++ b/libs/plugin-types/README.md
@@ -1,16 +1,20 @@
 # Penpot plugin-types
 
-This repository contains the typings for the Penpot Plugin API.
+The `@penpot/plugin-types` package provides TypeScript type definitions for the Penpot Plugin API, making it easier to develop plugins for the Penpot design platform with full type safety and IDE support. It streamlines the development process by ensuring that your code is well-typed and less prone to errors.
 
 ### Getting started
 
-Install the package:
+#### Installation
+
+To add penpot's plugin-types to your project, use the following command:
 
 ```bash
 npm install @penpot/plugin-types
 ```
 
-Configure `tsconfig.json`
+#### Configuration
+
+To ensure the typings work correctly in your project, update your tsconfig.json as follows:
 
 ```json
 "typeRoots": [
@@ -19,3 +23,7 @@ Configure `tsconfig.json`
 ],
 "types": ["plugin-types"],
 ```
+
+### Learn more
+
+For more information on how to build plugins using the Penpot PLugin API, refer to the <a href="https://penpot-docs-plugins.pages.dev/plugins/getting-started/" target="_blank">official documentation</a>. You can also explore practical examples in the <a href="https://github.com/penpot/penpot-plugins-samples" target="_blank">samples repository</a> to see real-world implementations.