No OneTemporary
Actions

Authored By

Unknown

Size

744 B

Referenced Files

None

Subscribers

None

View Options

	diff --git a/README.md b/README.md
	new file mode 100644
	index 0000000..14828a4
	--- /dev/null
	+++ b/README.md
	@@ -0,0 +1,22 @@
	+## UGlobalHotkey
	+
	+### Decription
	+UGlobalHotkey is an extension for Qt framework, which implements global hotkeys functionality for Windows and Linux platforms.
	+
	+### Building from source
	+* You can either open project with QtCreator and press Build button
	+* Or build it using terminal:
	+```
	+qmake
	+make
	+```
	+
	+### Usage example
	+```
	+UGlobalHotkeys *hotkeyManager = new UGlobalHotkeys();
	+hotkeyManager->RegisterHotkey("Ctrl+Shift+F12");
	+connect(hotkeyManager, &UGlobalHotkeys::Activated, [=](size_t id)
	+{
	+ qDebug() << "Activated: " << QString::number(id);
	+});
	+```
	\ No newline at end of file