Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
brunurd authored Nov 13, 2021
1 parent 67a94b3 commit 7cad518
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,43 @@ Did you know Compy the companion? They are a friendly mini browser to pin on top

### Tested services

|Name|Works|
|-|-|
|Twitch|:heavy_check_mark:|
|Youtube|:heavy_check_mark:|
|SoundCloud|:heavy_check_mark:|
|Netflix|:x:|
|DisneyPlus|:x:|
|Name|Works|Info|
|-|-|-|
|Twitch|:heavy_check_mark:|Ok|
|Youtube|:heavy_check_mark:|Ok|
|SoundCloud|:heavy_check_mark:|Ok|
|Netflix|:x:|DRM problem, needs Widevine|
|DisneyPlus|:x:|DRM problem|

## Downloads
:warning: **Observation:** At the moments the releases are made manually, I need time to create a proper continous distribution automation routine, follow the instruction on [How to Compile](#user-content-how-to-compile) if you want a specific version.

[Windows x64][win-download] | [macOS][mac-download] | [Linux][linux-download]

![Screenshot][screenshot]

_Streamer at the screenshot: [@rawrafaela](https://www.twitch.tv/rawrafaela) member of the [@wakandastreamers](https://www.twitch.tv/team/wakandastreamers) team._

## How to Compile
Pre-requisites:
- Run on the target platform: Windows, MacOS or Linux (In Linux it uses AppImage)
- Node.js

Install dependencies with:
```bash
npm install
```
Run the distribution command:
```bash
# For Linux
npm run dist:linux

# For Windows
npm run dist:win

# For mac
npm run dist:mac
```
[screenshot]: public/images/screenshot.gif
[license-badge]: https://img.shields.io/github/license/brunurd/companion
[npm-version]: https://img.shields.io/github/package-json/v/brunurd/companion
Expand Down

0 comments on commit 7cad518

Please sign in to comment.