diff --git a/README.md b/README.md index ccb79d6..235bb56 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ ## Beeper -A music sequencer using [Electron][electron], [React][react] and [Redux][redux]. +![Beeper](beeper.gif) -### Usage +A music sequencer and synthesizer written entirely in JavaScript. + +https://beeper-production.up.railway.app/ -To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line: +### Usage ```bash # Clone this repository @@ -18,25 +20,3 @@ npm install To start the app run: `npm start` - -### URL LAUNCHER config via ENV VARS - -If you are launching the application using resin, simply set these [environment varables](http://docs.resin.io/#/pages/management/env-vars.md) in your app via "Environment Variables" panel in the resin dashboard to configure the behaviour of your devices. -*__Please note that the `bool` type definition in the table is meant to accept to either `0` or `1` values.__* - -* **`URL_LAUNCHER_URL`** *string* - the URL to be loaded. use `file:////usr/src/app/data/index.html` to load a local electronJS (or any website) app - *defaults to* `file:////usr/src/app/data/index.html` -* **`URL_LAUNCHER_NODE`** *bool* (converted from *string*) - whether or not enable nodejs - *defaults to* `0` -* **`URL_LAUNCHER_KIOSK`** *bool* (converted from *string*) - whether or not enter KIOSK mode - *defaults to* `1` -* **`URL_LAUNCHER_TITLE`** *string* - the title of the window. Seen only with `URL_LAUNCHER_FRAME`=`true` - *defaults to* `RESIN.IO` -* **`URL_LAUNCHER_FRAME`** *bool* (converted from *string*) - set to "true" to display the window frame. Seen only with `URL_LAUNCHER_KIOSK`=`false` - *defaults to* `0` -* **`URL_LAUNCHER_CONSOLE`** *bool* (converted from *string*) - set to "true" to display the debug console - *defaults to* `0` -* **`URL_LAUNCHER_WIDTH`** *int* (converted from *string*) - - *defaults to* `1920` -* **`URL_LAUNCHER_HEIGHT`** *int* (converted from *string*) - - *defaults to* `1080` -* **`URL_LAUNCHER_TOUCH`** *bool* (converted from *string*) - enables touch events if your device supports them - *defaults to* `0` -* **`URL_LAUNCHER_TOUCH_SIMULATE`** *bool* (converted from *string*) - simulates touch events - might be useful for touchscreen with partial driver support - be aware this could be a performance hog - *defaults to* `0` -* **`URL_LAUNCHER_ZOOM`** *float* (converted from *string*) - The default zoom factor of the page, 3.0 represents 300% - *defaults to* `1.0` -* **`URL_LAUNCHER_OVERLAY_SCROLLBARS`** *bool* (converted from *string*) - enables overlay scrollbars - *defaults to* `0` - -[electron]: http://electron.atom.io/ -[react]: https://facebook.github.io/react/ -[redux]: http://redux.js.org/ diff --git a/beeper.gif b/beeper.gif new file mode 100644 index 0000000..83d97bc Binary files /dev/null and b/beeper.gif differ