diff options
Diffstat (limited to 'types/README.md')
-rw-r--r-- | types/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/types/README.md b/types/README.md new file mode 100644 index 000000000..adeca48e5 --- /dev/null +++ b/types/README.md | |||
@@ -0,0 +1,19 @@ | |||
1 | # PeerTube typings | ||
2 | |||
3 | These **Typescript** *types* are mainly used to write **PeerTube** plugins. | ||
4 | |||
5 | ## Installation | ||
6 | |||
7 | Npm: | ||
8 | ``` | ||
9 | npm install --save-dev @peertube/peertube-types | ||
10 | ``` | ||
11 | |||
12 | Yarn: | ||
13 | ``` | ||
14 | yarn 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. | ||