Skip to content

Commit

Permalink
Misc: Add badges to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Piotrekol authored Aug 17, 2021
1 parent 9f01a70 commit 40dc6e6
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@

### ![StreamCompanion](images/logo.png)
**StreamCompanion** is a program directed towards osu! streamers, with functions such as a *pp counter* and *map information*

### Functions
**StreamCompanion** is a program directed towards osu! streamers, with functions such as a *pp counter* and *map information*

[![AppVeyor](https://img.shields.io/appveyor/build/Piotrekol/StreamCompanion/master)](https://ci.appveyor.com/project/Piotrekol/streamcompanion)
[![Discord](https://img.shields.io/discord/452057328532062219?label=Discord)][discord]
[![License](https://img.shields.io/github/license/Piotrekol/StreamCompanion)][license]
[![Latest GitHub release](https://img.shields.io/github/v/release/Piotrekol/StreamCompanion)](https://github.com/Piotrekol/StreamCompanion/releases/latest)
![GitHub downloads](https://img.shields.io/github/downloads/Piotrekol/StreamCompanion/total)
[![StreamCompanionTypesNuget](https://img.shields.io/nuget/v/streamCompanionTypes?label=StreamCompanionTypes)](https://github.com/Piotrekol/StreamCompanionTypes)

## Functions
- Grabbing song title **anywhere** you are in osu!
- A simplistic map and PP web displays
- Customizable map outputs
Expand All @@ -12,23 +18,24 @@
- [osu!Post][osuPost] integration
- Magic(and more)

### Help!
## Help!
StreamCompanion has a wiki explaining most of its functionality. [Give it a read][wiki] if you are having problems or wish to know what SC can do.

Any contributions / constructive criticism is appreciated

### Built in web overlays support
## Built in web overlays support
After starting StreamCompanion navigate to http://localhost:20727/ to see default web overlays. All overlays live in `Files/Web/overlays/` folder and you're free to create/edit these as you see fit.
Default `Live Overlay` can be configured to some extent in settings `Visualizer` tab without having to tinker with js/css.
![WebOverlayPreview](images/webOverlay.jpg)

## Plugins
StreamCompanion supports and treats plugins as first-class citizen - [majority of its functionality is written using this system](./plugins)
If you wish to create plugin/use SC for something and have no clue where to start - create a Github issue or ask on [Discord](https://discord.gg/N854wYZ)
If you wish to create plugin/use SC for something and have no clue where to start - create a Github issue or ask on [Discord][discord]

## License
This software is licensed under MIT. You can find the full text of the license [here][license].

[license]: <https://github.com/Piotrekol/StreamCompanion/blob/master/LICENSE>
[osuPost]: <https://osu.ppy.sh/forum/t/164486>
[wiki]: <https://github.com/Piotrekol/StreamCompanion/wiki>
[discord]: <https://discord.gg/N854wYZ>

0 comments on commit 40dc6e6

Please sign in to comment.