Added description and instructions in README.md

This commit is contained in:
Dmitry Lyukov
2016-03-30 02:50:39 +03:00
parent 4ec6992e16
commit c187876359

View File

@@ -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)
[![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>`
Где `keyboard_id` можно получить командой:
`xinput list`
Собранные данные можно экспортировать в форматы
* `csv` и `csv.gz`
* `json` и `json.gz`
* `jsl` и `jsl.gz`
Для экспорта необходимо запустить с ключом `-o`:
`./gokeystat -o example.csv`
Чтобы вывести информацию по каждой клавише, следует добавить ключ `-full`.