Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BjoernPetersen committed Sep 15, 2019
1 parent 91a6a7a commit 592f750
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

[![GitHub (pre-)release](https://img.shields.io/github/release/BjoernPetersen/volctl/all.svg)](https://github.com/BjoernPetersen/volctl/releases) [![GitHub license](https://img.shields.io/github/license/BjoernPetersen/volctl.svg)](https://github.com/BjoernPetersen/volctl/blob/master/LICENSE)

A simple Kotlin library providing access to audio volume control.
A simple Kotlin library providing access to audio volume control on Windows and Linux.
Can also be used from Java.

The library uses native C++ code to directly access the relevant system APIs,
there are no further dependencies.

## Compatibility

This library is compatible with Java 1.8+.

**Note:** volctl is only compatible with Windows for now.

## Usage

### Example
Expand Down Expand Up @@ -87,6 +88,7 @@ Before packaging, you'll need to generate the header files and compile the nativ
```

Note that this requires CMake and a C++ toolchain to be installed.
Only the native library for the current platform will be built.

## License

Expand Down

0 comments on commit 592f750

Please sign in to comment.