aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-09-07 11:47:40 +0200
committerChocobozzz <me@florianbigard.com>2021-09-07 11:47:40 +0200
commit6f9719b568fad75959a1404b6927b7a278061c41 (patch)
tree0d982298e429a67e8f4cb8bb79bd9f2eb0337622
parentdbe91db73e8b7992b414bdc0d3088dc73dde40b6 (diff)
downloadPeerTube-6f9719b568fad75959a1404b6927b7a278061c41.tar.gz
PeerTube-6f9719b568fad75959a1404b6927b7a278061c41.tar.zst
PeerTube-6f9719b568fad75959a1404b6927b7a278061c41.zip
Add dev lib documentation
-rw-r--r--client/.gitignore2
-rw-r--r--client/src/standalone/player/package.json2
-rw-r--r--support/doc/development/lib.md10
3 files changed, 13 insertions, 1 deletions
diff --git a/client/.gitignore b/client/.gitignore
index a02b6a6cc..7297b43fc 100644
--- a/client/.gitignore
+++ b/client/.gitignore
@@ -9,3 +9,5 @@
9/src/locale/target/player_*.xml 9/src/locale/target/player_*.xml
10/src/locale/target/server_*.xml 10/src/locale/target/server_*.xml
11/e2e/local.log 11/e2e/local.log
12/src/standalone/player/build
13/src/standalone/player/dist
diff --git a/client/src/standalone/player/package.json b/client/src/standalone/player/package.json
index 985097af5..78b3cd93f 100644
--- a/client/src/standalone/player/package.json
+++ b/client/src/standalone/player/package.json
@@ -4,7 +4,7 @@
4 "version": "0.0.4", 4 "version": "0.0.4",
5 "description": "API to communicate with the PeerTube player embed", 5 "description": "API to communicate with the PeerTube player embed",
6 "scripts": { 6 "scripts": {
7 "test": "echo \"Error: no test specified\" && exit 1" 7 "build": "../../../node_modules/.bin/tsc && ../../../node_modules/.bin/webpack --mode production --config ./webpack.config.js"
8 }, 8 },
9 "repository": { 9 "repository": {
10 "type": "git", 10 "type": "git",
diff --git a/support/doc/development/lib.md b/support/doc/development/lib.md
new file mode 100644
index 000000000..6b0372150
--- /dev/null
+++ b/support/doc/development/lib.md
@@ -0,0 +1,10 @@
1# Lib development documentation
2
3## @peertube/embed-api
4
5### Build
6
7```
8$ cd client/src/standalone/player/
9$ npm run build
10```