Skip to content
This repository has been archived by the owner on May 5, 2021. It is now read-only.

Commit

Permalink
Version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
zspri committed Aug 19, 2018
1 parent 0ba4861 commit 9d11e29
Show file tree
Hide file tree
Showing 5 changed files with 1,605 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
config.json
new_cmd_window.bat
TwitchOverlay-win32-x64/
dist/

# Logs
logs
Expand Down
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@ A custom Twitch IRC client built with Electron

## Requirements

- Node 8 or above
- npm
- Electron 2.0.4
- Windows (x64)
- Windows (64-bit)

### Dev requirements

- Node 8 or above
- Electron 2.0.4
- electron-builder

## Installing

**Production:**
Download ./TwitchOverlay-win32-x64.zip, extract the files, and run TwitchOverlay.exe
### Production (regular users)

Go to the [releases](https://github.com/devakira/TwitchOverlay/releases) page and download 'TwitchOverlay (version).exe'

### Development

**Development:**
```sh
git clone https://github.com/devakira/TwitchOverlay
cd TwitchOverlay
Expand All @@ -27,3 +32,12 @@ electron .
## Logging in

As of Sept. 17, 2013, Twitch now requires that you log into IRC using an OAuth token instead of your plaintext password or hash for additional security. To generate an oAuth token, go to https://twitchapps.com/tmi/, click `Connect with Twitch`, and copy the text in the box.

## Building

```sh
npm install
electron-builder --windows portable
```

This will generate an executable at `./dist/TwitchOverlay (version).exe`.
Binary file removed TwitchOverlay-win32-x64.zip
Binary file not shown.
Loading

0 comments on commit 9d11e29

Please sign in to comment.