1 files changed, 43 insertions, 0 deletions

diff --git a/apps/peertube-runner/README.md b/apps/peertube-runner/README.md
new file mode 100644
index 000000000..37760f867
--- /dev/null
+++ b/apps/peertube-runner/README.md
@@ -0,0 +1,43 @@
+# PeerTube runner
+
+Runner program to execute jobs (transcoding...) of remote PeerTube instances.
+
+Commands below has to be run at the root of PeerTube git repository.
+
+## Dev
+
+### Install dependencies
+
+```bash
+cd peertube-root
+yarn install --pure-lockfile
+cd apps/peertube-runner && yarn install --pure-lockfile
+```
+
+### Develop
+
+```bash
+cd peertube-root
+npm run dev:peertube-runner
+```
+
+### Build
+
+```bash
+cd peertube-root
+npm run build:peertube-runner
+```
+
+### Run
+
+```bash
+cd peertube-root
+node apps/peertube-runner/dist/peertube-runner.js --help
+```
+
+### Publish on NPM
+
+```bash
+cd peertube-root
+(cd apps/peertube-runner && npm version patch) && npm run build:peertube-runner && (cd apps/peertube-runner && npm publish --access=public)
+```