Skip to content

Commit

Permalink
feat(api-doc): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mavalroot committed Sep 18, 2024
1 parent 2909bcc commit 99ff81d
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions libs/plugin-types/README.md
Original file line number Diff line number Diff line change
@@ -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": [
Expand All @@ -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.

0 comments on commit 99ff81d

Please sign in to comment.