aboutsummaryrefslogtreecommitdiffhomepage
path: root/packages/types/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/types/README.md')
-rw-r--r--packages/types/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/packages/types/README.md b/packages/types/README.md
new file mode 100644
index 000000000..adeca48e5
--- /dev/null
+++ b/packages/types/README.md
@@ -0,0 +1,19 @@
1# PeerTube typings
2
3These **Typescript** *types* are mainly used to write **PeerTube** plugins.
4
5## Installation
6
7Npm:
8```
9npm install --save-dev @peertube/peertube-types
10```
11
12Yarn:
13```
14yarn add --dev @peertube/peertube-types
15```
16
17## Usage
18
19> See [contribute-plugins](https://docs.joinpeertube.org/contribute-plugins?id=typescript) **Typescript** section of the doc.