From c187876359404c9aa2832f1e64b71c25567ecec8 Mon Sep 17 00:00:00 2001 From: Dmitry Lyukov Date: Wed, 30 Mar 2016 02:50:39 +0300 Subject: [PATCH] Added description and instructions in README.md --- Readme.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index f77813f..df76a12 100644 --- a/Readme.md +++ b/Readme.md @@ -1,3 +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) \ No newline at end of file +[![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