aboutsummaryrefslogtreecommitdiffhomepage
path: root/types/README.md
diff options
context:
space:
mode:
authorlutangar <johan.dufour@gmail.com>2021-11-09 13:49:08 +0100
committerChocobozzz <chocobozzz@cpy.re>2021-12-16 10:08:43 +0100
commitb8fa3e8c734a46918118afe7976f248cc883f675 (patch)
tree0ebf8fd10b1c690602da14d4dd626cd04a9ff748 /types/README.md
parent8b03e2ce1a2098261de2f729f660b1ae2a320b65 (diff)
downloadPeerTube-b8fa3e8c734a46918118afe7976f248cc883f675.tar.gz
PeerTube-b8fa3e8c734a46918118afe7976f248cc883f675.tar.zst
PeerTube-b8fa3e8c734a46918118afe7976f248cc883f675.zip
refactor(types): create dedicated folder for types package src
fix guide examples and add types package readme refactor(tsconfig): move back base tsconfig to base directory
Diffstat (limited to 'types/README.md')
-rw-r--r--types/README.md19
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
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.