# Packages
# README

Keylogme Zero
This is a logger for [keylogme.com](https://keylogme.com) . This logger saves
the stats locally. You can use those results to visualize in (pending...).
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
The end goal is to avoid or diminish the pain in your hands due to typing. Commonly known as RSI (Repetitive Strain Injury), tennis elbow, carpal tunnel syndrome, etc.
There are many great ergonomic keyboards , beautiful hardware out there. However, what is the layout of keys that best suits you? that does not cause you pain? that makes you more productive?.
We all started with QWERTY, then heard of DVORAK, COLEMAK, Workman, Norman, Asset, Capewell-Dvorak, BEAKL, MTGAP, QGMLWB... ? There are many layouts but switching to one is not an easy task, you need a lot of practice and patience.
Here's how:
- Monitor : See the finger usage on your layout based on your real usage
- Analyze : Compare your layout with others, find patterns to avoid or improve, remap shortcuts
- Adapt : fine tune your layout based on the stats
Of course, ergonomics is not just a nice keyboard and layout. It is also about posture, breaks, exercises.
Security
A keylogger is a tool that records the keystrokes on a computer. It can be used for good or bad purposes. Of course, our intention is to use it for good purposes. How can you trust that?, well the code is completely open source, no dependencies and it stores your data locally in your computer, there is no connection to the internet.
The online viewer does not need an account to use it. You can use it anonymously to visualize your stats.
Getting Started
Linux
TODO Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Install the service
git clone https://github.com/github_username/repo_name.git
- Config file
git clone https://github.com/github_username/repo_name.git
- Start using your devices at work
npm install
- After some time, check the stats
Config
TODO
Roadmap
TODO
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Efrain Sotelo - @esoteloferry
Project Link: https://keylogme.com
Acknowledgments
Helpful resources and would like to give credit to.
- Linux keylogger helpful starting point