From 0a508b46536b456a6de03a9f3e8f5acdcf3a9e68 Mon Sep 17 00:00:00 2001 From: nklhrstv Date: Tue, 7 Apr 2020 17:23:05 +0300 Subject: [PATCH] Build instructions added to README --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3974e4cb8..2772fe848 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,29 @@ -Stremio - the next generation media center -================ +# Stremio - the next generation media center + +![Build](https://github.com/stremio/stremio-web/workflows/Build/badge.svg?branch=development) Stremio is a modern media center that's a one-stop solution for your video entertainment. You discover, watch and organize video content from easy to install addons. -![Build](https://github.com/stremio/stremio-web/workflows/Build/badge.svg?branch=development) +## Build + +#### Prerequisites: +* Node.js 10 or higher +* yarn __configured for use with GitHub Packages__ + +### Install dependencies: + +```bash +yarn install +``` + +### Development: + +```bash +yarn start +``` + +### Production: + +```bash +yarn build +```