Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
EpicnessTwo committed Jan 8, 2024
1 parent 2c777ce commit f1b4822
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
Binary file added .github/images/streamlurker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 37 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# Twitch Stream Lurker
# StreamLurker - A Twitch Chat Client
![GitHub release (latest by date)](https://img.shields.io/github/v/release/EpicnessTwo/StreamLurker)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/U7U1RLHUW)

> Whilst this client is mostly functional, it is still in development and may have bugs. Please report any bugs you find to the [issues](https://github.com/EpicnessTwo/StreamLurker/issues) page.
![Stream Lurker Interface](.github/images/streamlurker.png)

## About
StreamLurker is a small client that quickly shows you which of your favourite streamers are live, with the ability to automatically open their streams. It is designed to be lightweight and easy to use.

## Features
- Quickly see which of your favourite streamers are live
- Automatically open streams when they go live
- Customise the list of monitored streamers

## Installation

Navigate to the [releases](https://github.com/EpicnessTwo/StreamLurker/releases) page and download the latest version for your operating system.

## Development

### Prerequisites
- [Node.js](https://nodejs.org/en/) (v12.0.0 or higher)

### Setup
1. Clone the repository
2. Install dependencies with `npm install`
3. Run the application with `npm start`
4. Build the application with `npm run dist`

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

0 comments on commit f1b4822

Please sign in to comment.