From df68e745b9950c16f8979165e0e2b6ad3b19aaea Mon Sep 17 00:00:00 2001 From: Dmitry Lyukov Date: Wed, 30 Mar 2016 02:58:05 +0300 Subject: [PATCH] Changed README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf21588 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# gokeystat +[![Travis status](https://travis-ci.org/AlekseyLobanov/gokeystat.svg)](https://travis-ci.org/AlekseyLobanov/gokeystat) +[![Go Report Card](https://goreportcard.com/badge/github.com/alekseylobanov/gokeystat)](https://goreportcard.com/report/github.com/alekseylobanov/gokeystat) + +**gokeystat** позволяет собирать статистику использования клавиатуры, подсчитывая и сохраняя каждые 15 минут количество нажатий каждой клавиши. + +Для запуска необходимо выполнить: + +`./gokeystat -id ` + +Где `keyboard_id` можно получить командой: + +`xinput list` + +Собранные данные можно экспортировать в форматы + +* `csv` и `csv.gz` +* `json` и `json.gz` +* `jsl` и `jsl.gz` + +Для экспорта необходимо запустить с ключом `-o`: + +`./gokeystat -o example.csv` + +Чтобы вывести информацию по каждой клавише, следует добавить ключ `-full`. \ No newline at end of file