Skip to content

Commit a37c455

Browse files
committed
add badges to readme
1 parent c5e8838 commit a37c455

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# Keylogger ⌨️
2+
<div align="center">
3+
4+
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
5+
![Shell Script](https://img.shields.io/badge/shell_script-%23121011.svg?style=for-the-badge&logo=gnu-bash&logoColor=white)
6+
[![CodeFactor](https://www.codefactor.io/repository/github/weslley41/keylogger_python/badge?style=for-the-badge)](https://www.codefactor.io/repository/github/weslley41/keylogger_python)
7+
[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen?style=for-the-badge)](https://github.com/PyCQA/pylint)
8+
</div>
29

310
Por curiosidade, eu queria saber o quanto uso o teclado diariamente. Então criei um script python utilizando algumas bibliotecas, enquanto em execução ele registra a quantidade de vezes que a uma tecla é pressionada.
411

@@ -11,7 +18,7 @@ Por curiosidade, eu queria saber o quanto uso o teclado diariamente. Então crie
1118
## 🔍 Descrição
1219
Enquanto o programa está sendo executado ele faz a leitura de todas as teclas usadas e contabiliza em um banco de dados mysql local. Os scripts foram feitos majoritariamente em Python, com exceção do arquivo de auto configuração que utiliza ShellScript.
1320

14-
### Keylogger cli
21+
### Keylogger CLI
1522
O keylogger cli é um script onde você pode ver as estatísticas de uso, como: teclas mais utilizadas, gerar um arquivo de log ou exibir um gráfico de uso semanal.
1623
Para pegar os dados do banco de dados o script se conecta à uma api (também rodando localmente).
1724

@@ -52,6 +59,15 @@ ctrl 248
5259
![weekly-graphic](screenshots/weekly_graphic.png)
5360

5461
## Configurações
62+
<div align="center">
63+
64+
[![GitHub Pipenv locked Python version](https://img.shields.io/github/pipenv/locked/python-version/weslley41/keylogger_python)](https://www.python.org/)
65+
[![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/weslley41/keylogger_python/keyboard)](https://pypi.org/project/keyboard/)
66+
[![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/weslley41/keylogger_python/matplotlib)](https://pypi.org/project/matplotlib/)
67+
[![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/weslley41/keylogger_python/mysql-connector-python)](https://pypi.org/project/mysql-connector-python/)
68+
[![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/weslley41/keylogger_python/pipenv)](https://pypi.org/project/pipenv/)
69+
[![GitHub Pipenv locked dependency version](https://img.shields.io/github/pipenv/locked/dependency-version/weslley41/keylogger_python/pylint)](https://pypi.org/project/pylint/)
70+
</div>
5571
Para fazer a configuração você precisa ter instalado a versão 3.10 do Python, o pipenv e um servidor mysql rodando. Com isso basta executar o arquivo 'bin/autoconfig.sh' e preencher os campos necessários para configurar os serviços locais.
5672

5773
`
@@ -61,7 +77,7 @@ chmod +x bin/autoconfig.sh
6177

6278
Se tudo ocorrer bem, seu keylogger estará funcionando.
6379

64-
### Atalho para o Keylogger cli
80+
### Atalho para o Keylogger CLI
6581
Quanto ao keylogger cli, você pode criar um atalho para ele usando o `alias`, por exemplo:
6682

6783
`alias keylogger_cli="python path/to/keylogger_python/bin/keylogger_cli.py"`

0 commit comments

Comments
 (0)