diff --git a/libs/plugin-types/README.md b/libs/plugin-types/README.md index d9af74d..a23f2d2 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 official documentation. You can also explore practical examples in the samples repository to see real-world implementations.