From 61022a65f0a059fae6a69e81524ca5df1fccb5a9 Mon Sep 17 00:00:00 2001 From: Olof Rappestad Date: Thu, 4 Oct 2018 21:00:04 +0200 Subject: [PATCH] add demo section to readme --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c85958fcb6..e7ee200d9f 100755 --- a/README.md +++ b/README.md @@ -133,6 +133,18 @@ graph.start() It includes several commands in the utils folder to generate doc, check errors and build minifyed version. +## Demo +----- +The demo includes three examples: Audio, Audio Delay and Audio Reverb. In order to try them on your local computer, you need `git`, `node` and `npm`. Given those dependencies are installed, run the following commands to try it out: +```sh +$ git clone git@github.com:jagenjo/litegraph.js.git +$ cd litegraph.js +$ npm install +$ node utils/server.js +Example app listening on port 80! +``` +Open your browser and point it to http://localhost. You can select demo from the dropdown at the top of the page. + ## Feedback -------- @@ -141,6 +153,3 @@ You can write any feedback to javi.agenjo@gmail.com ## Contributors - kriffe - - -