diff --git a/README.md b/README.md index 84099fe..2c26975 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,56 @@ [![Build Status](https://travis-ci.com/Junker/mictray.svg?branch=master)](https://travis-ci.com/Junker/mictray) # MicTray + MicTray is a Lightweight application which lets you control the microphone state and volume from system tray -### Requirements +## Requirements + * PulseAudio * Gtk -### Control +## Control + * Left-Button click - mute/unmute * Middle-Button click - mixer * Srcoll - Volume up/down -### Build & Install +## Build & Install + +```bash +meson build --prefix=/usr +cd build +ninja +sudo ninja install +``` + +## Install from Arch Linux & Manjaro + +```yaourt -S mictray``` + +## Install from Ubuntu + +```bash +add-apt-repository ppa:mictray/mictray +apt-get update +apt-get install mictray +``` + +## DBUS + +**Path**: /app/junker/mictray +**Interface**: app.junker.mictray + +### DBUS methods - meson build --prefix=/usr - cd build - ninja - sudo ninja install +* ToggleMute +* Mute +* Unmute +* IncreaseVolume +* DecreaseVolume -### Install from Arch Linux & Manjaro - yaourt -S mictray +### DBUS usage example -### Install from Ubuntu - add-apt-repository ppa:mictray/mictray - apt-get update - apt-get install mictray +```bash +dbus-send --dest=app.junker.mictray --print-reply /app/junker/mictray app.junker.mictray.ToggleMute +```