diff --git a/api/README.md b/api/README.md index e55faaa..952268f 100644 --- a/api/README.md +++ b/api/README.md @@ -1,32 +1,35 @@ ## DOWNstream For Electron [![Build Status](https://travis-ci.org/castlabs/downstream_electron.svg?branch=master)](https://travis-ci.org/castlabs/downstream_electron) - + [DOWNstream](https://github.com/castlabs/downstream_electron) is an open-source plugin to use with Electron allowing encrypted MPEG-DASH and Smooth Streaming streams to be safely downloaded and stored locally on a user’s Windows or Mac computer. ### Installation + ```bash npm install downstream-electron --save ``` ### Main process - [DownstreamElectronBE](DownstreamElectronBE.html) + +[DownstreamElectronBE](DownstreamElectronBE.html) ### Renderer process - [DownstreamElectronFE](DownstreamElectronFE.html) + +[DownstreamElectronFE](DownstreamElectronFE.html) ### See available configuration - [Downstream Configuration](DownstreamElectronBE.configuration.html) +[Downstream Configuration](DownstreamElectronBE.configuration.html) ## castLabs Electron Release for Content Security -To simplify the use of Widevine DRM and allow protected playback of offline content within Electron CastLabs has created a fork with support for Widevine CDM installation, Verified Media Path (VMP), and protected storage of offline licenses. +To simplify the use of Widevine DRM and allow protected playback of offline content within Electron CastLabs has created a fork with support for Widevine CDM installation, Verified Media Path (VMP), and protected storage of offline licenses. Such a release is installed by the default npm package scripts. More information is available here: https://github.com/castlabs/electron-releases - ## License + Copyright (C) 2017 Castlabs GmbH. Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/integrations/redux/src/components/Footer.js b/integrations/redux/src/components/Footer.js index 7faed7b..49d2fcb 100644 --- a/integrations/redux/src/components/Footer.js +++ b/integrations/redux/src/components/Footer.js @@ -16,7 +16,7 @@ const Footer = ({ removeAll, visible }) => ( {visible && } - castLabs @ 2019 + Castlabs @ 2019 ) diff --git a/jsdoc.conf.json b/jsdoc.conf.json index f0f98f0..1fc7b86 100644 --- a/jsdoc.conf.json +++ b/jsdoc.conf.json @@ -10,7 +10,7 @@ "cleverLinks": false, "monospaceLinks": false, "name": "DOWNstream For Electron", - "footerText": "castLabs DOWNstream For Electron", + "footerText": "Castlabs DOWNstream For Electron", "default": { "outputSourceFiles": false, "useLongnameInNav": true diff --git a/package.json b/package.json index f66d3e9..c792caa 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "files" ], "main": "index.js", - "homepage": "https://castlabs.com/resources/downstream/", + "homepage": "https://castlabs.com/", "scripts": { "update": "ncu -u", "build": "NODE_OPTIONS=\"--openssl-legacy-provider\" && webpack", diff --git a/readme.md b/readme.md index 6fa0423..57fc9de 100644 --- a/readme.md +++ b/readme.md @@ -4,9 +4,9 @@ DOWNstream is an open-source plugin to use with Electron allowing encrypted MPEG-DASH and Smooth Streaming streams to be safely downloaded and stored locally on a user’s Windows or Mac computer. -## castLabs Electron Release for Content Security +## Castlabs Electron Release for Content Security -To simplify the use of Widevine DRM and allow protected playback of offline content within Electron castLabs has created a fork with support for Widevine CDM installation, Verified Media Path (VMP), and protected storage of offline licenses. Such a release is installed by the default npm package scripts, see [Development](#development) and [Build](#build) sections below. +To simplify the use of Widevine DRM and allow protected playback of offline content within Electron Castlabs has created a fork with support for Widevine CDM installation, Verified Media Path (VMP), and protected storage of offline licenses. Such a release is installed by the default npm package scripts, see [Development](#development) and [Build](#build) sections below. More information is available here: @@ -14,7 +14,7 @@ https://github.com/castlabs/electron-releases ## Development -1. *(optional)* `npm run clean` +1. _(optional)_ `npm run clean` 2. `npm install` 3. `npm start` @@ -27,9 +27,9 @@ https://github.com/castlabs/electron-releases ## Examples 1. `npm install` -2. `npm start -- example=`*name* +2. `npm start -- example=`_name_ -- (*default*) Example: **main** +- (_default_) Example: **main** Extended example showing most of the features of the **downstream_electron** library @@ -58,7 +58,7 @@ with React & Redux frameworks. ## Documentation -Documentation is available publicly at +Documentation is available publicly at https://castlabs.github.io/downstream_electron/ 1. `npm run jsdoc` @@ -79,10 +79,6 @@ https://castlabs.github.io/downstream_electron/ - Electron installation in macOS (https://github.com/castlabs/electron-releases/issues/144) - we recommend to use one of the workaround mentioned in the GitHub issue. -## More information - -https://castlabs.com/resources/downstream/ - ## License Copyright (C) 2017 Castlabs GmbH.