Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rolfheij-sil committed Dec 7, 2023
1 parent f50b983 commit 5e65e1c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions lib/papi-dts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ This is a types package that provides type declarations for `papi` and other imp

The documentation includes a variety of types to support different aspects of the project. For extension development, the most crucial sections to focus on are:

- `@papi/frontend`: Papi objects that can be accessed in the frontend of the extension.
- `@papi/frontend/react`: React hooks to help interaction between React components and the Papi.
- `@papi/backend`: Papi objects that can be accessed in the backend of the extension.
- `@papi/shared`: Declarations shared between core and extensions
- `@papi/backend`: PAPI objects that can be accessed in the backend of the extension.
- `@papi/core`: Types for use when interacting with the PAPI.
- `@papi/frontend`: PAPI objects that can be accessed in the frontend of the extension.
- `@papi/frontend/react`: React hooks to help interaction between React components and the PAPI.
- `papi-shared-types`: Extensible interface declarations shared between core and extensions to expose extension API types on the PAPI

Feel free to explore other sections based on your specific needs and context.

Expand Down

0 comments on commit 5e65e1c

Please sign in to comment.