Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thehelvijs authored Jul 2, 2020
1 parent ba9fd46 commit 7cc74ed
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Caffeinated
# Casterlabs Caffeinated
<p align="center">
<img width="500" src="https://github.com/thehelvijs/Caffeinated/blob/master/README/usage.gif">
</p>

Caffeinated has been merged with [Casterlabs](https://casterlabs.co).
No login required. Using local web-server to display alerts and chat. Based on Electron JS. Tested only on Windows. <br /><br />

Basic features:
Expand Down Expand Up @@ -30,8 +31,6 @@ Give a follow to [Caffeinated](https://www.caffeine.tv/Caffeinated_)

## Usage
- Set user in settings
- (If first time ever using - restart Caffeinated)

### 1: browser source

- In OBS add Browser Source (can copy from Caffeinated mainscreen):
Expand Down Expand Up @@ -67,18 +66,14 @@ Give a follow to [Caffeinated](https://www.caffeine.tv/Caffeinated_)
- ~~Empty donation message gives default message from donation test -> should be left empty.~~
- If more localhost links are open, audio plays for every window and becomes distorted/loud. Have to limit to 1 window.
- Overlapping alerts - a delay has to be set so all alerts play after previous one has finished.
- A lot more that me and [e3ndr](https://github.com/e3ndr/) are working on

## For developers

```elm
git clone https://github.com/thehelvijs/Caffeinated
npm install
npm start
```
Private API endpoints:
- https://caffeinated-api.herokuapp.com/users/$username$
- https://caffeinated-api.herokuapp.com/followers/$username$ (gives 5 latest followers)
- https://caffeinated-api.herokuapp.com/followers/$username$/$follower_count$ (gives last followers where follower_count is 1-100 (Caffeine caps them at 100))
## Acknowledgments

- [e3ndr](https://github.com/e3ndr/) for inspiration and software examples for chat and donations
Expand Down

0 comments on commit 7cc74ed

Please sign in to comment.