xyvs/wakapi-readme-stats
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

docs: restore the English version of README.md

Browse Source
This commit is contained in:
iamgrodrigues
2020-12-13 00:22:06 -03:00
parent 51c30d1ec2
commit 77eb06b689
1 changed files with 104 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

207
README.md
View File

@@ -1,6 +1,6 @@
> Buscando por Traduções em diferentes linguas & locais [#23](https://github.com/anmol098/waka-readme-stats/issues/23)
> Looking For Translation to different languages & Locale [#23](https://github.com/anmol098/waka-readme-stats/issues/23)
# Métricas de Desenvolvimento no Readme com feature flags adicionáveis 🎌
# Dev Metrics in Readme with added feature flags 🎌
![Project Preview](https://user-images.githubusercontent.com/25841814/79395484-5081ae80-7fac-11ea-9e27-ac91472e31dd.png)
@@ -8,7 +8,7 @@
![Project Preview](https://user-images.githubusercontent.com/15426564/88030180-8e1c4780-cb58-11ea-8a8b-b3576dd73652.png)
<h3 align="center">📌✨Incríveis Estatísticas no Readme</h3>
<h3 align="center">📌✨Awesome Readme Stats</h3>
</p>
----
@@ -21,63 +21,63 @@
<img src="https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=style=flat&color=BC4E99" alt="Star Badge"/>
</p>
<p align="center">
Você é diurno 🐤 ou noturno 🦉?
Are you an early 🐤 or a night 🦉?
<br/>
Quando você é mais produtivo durante o dia?
When are you most productive during the day?
<br/>
Quais são as linguagens com que você programa?
What are languages you code in?
<br/>
Vamos ver isso em seu perfil!
Let's check out in your profile readme!
</p>
<p align="center">
<a href="https://github.com/anmol098/waka-readme-stats/issues">Reporte Bug</a>
<a href="https://github.com/anmol098/waka-readme-stats/issues">Report Bug</a>
·
<a href="https://github.com/anmol098/waka-readme-stats/issues">Solicite Funcionalidades</a>
<a href="https://github.com/anmol098/waka-readme-stats/issues">Request Feature</a>
</p>
## Configuração Prévia
## Prep Work
1. Você precisa atualizar o arquivo markdown(.md) com 2 comentários. Verifique [aqui](#atualize-seu-readme) como fazer isso.
2. Você vai precisar de uma API Key do WakaTime. Você pode conseguir isso nas configurações da conta do Wakatime
- Você pode verificar [aqui](#novo-no-wakatime), caso seja novo no WakaTime
3. Você vai precisar de um API Token do GitHub com escopo de `repo` e `user` que poderá ser encontrado [aqui](https://github.com/settings/tokens) caso esteja usando o Action para pegar as métricas de commits
> habilitar o escopo de `repo` parece **PERIGOSO**<br/>
> mas esse GitHub Action apenas acessa a data e hora do seu commit e as linhas de códigos adicionadas ou deletadas no repositório que você contribuiu.
- Você pode usar [esse](#perfil-do-repositório) exemplo como modelo
4. Você precisa salvar a API Key do Wakatime e o API Token do GitHub no secrets do repositório. Você pode encontrar isso nas configurações do seu repositório. Certifique-se de salva-los como mostra no exemplo abaixo.
- API Key do WakaTime como `WAKATIME_API_KEY=<your wakatime API Key>`
- Token de Acesso Pessoal do GitHub como `GH_TOKEN=<your github access token>`
5. Você pode habilitar e desabilitar as feature flags baseando-se em seus requerimentos.
1. You need to update the markdown file(.md) with 2 comments. You can refer [here](#update-your-readme) for updating it.
2. You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
- You can refer [here](#new-to-wakatime), if you're new to WakaTime
3. You'll need a GitHub API Token with `repo` and `user` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics
> enabling the `repo` scope seems **DANGEROUS**<br/>
> but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.
- You can use [this](#profile-repository) example to work it out
4. You need to save the WakaTime API Key and the GitHub API Token in the repository secrets. You can find that in the Settings of your repository. Be sure to save those as the following.
- WakaTime API Key as `WAKATIME_API_KEY=<your wakatime API Key>`
- GitHub Personal Access Token as `GH_TOKEN=<your github access token>`
5. You can enable and disable feature flags based on requirements.
Essa Ação será executada todos os dias às 00.00 IST
This Action will run everyday at 00.00 IST
## Atualize seu Readme
## Update your Readme
Adicione um comentário igual a esse em seu `README.md`:
Add a comment to your `README.md` like this:
```md
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->
```
Estas linhas serão nosso ponto de entrada para as métricas de desenvolvimento.
These lines will be our entry-points for the dev metrics.
## Novo no WakaTime
## New to WakaTime
WakaTime te dá uma ideia do tempo que você realmente gastou programando. Isso te ajuda a dar um boost na sua produtividade e no seu lado competitivo.
WakaTime gives you an idea of the time you really spent on coding. This helps you boost your productivity and competitive edge.
- Vá para <https://wakatime.com> e crie uma conta.
- Gere sua API Key do WakaTime em [Account Settings in WakaTime](https://wakatime.com/settings/account).
- Instale o [WakaTime plugin](https://wakatime.com/plugins) no seu editor favorito / IDE.
- Cole sua API key para iniciar suas alálises.
- Head over to <https://wakatime.com> and create an account.
- Get your WakaTime API Key from your [Account Settings in WakaTime](https://wakatime.com/settings/account).
- Install the [WakaTime plugin](https://wakatime.com/plugins) in your favourite editor / IDE.
- Paste in your API key to start the analysis.
### Perfil do Repositório
### Profile Repository
Você vai precisar de um [GitHub Access Token](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) com escopo de `repo` e `user` e salva-lo no Secrets do repositório `GH_TOKEN = <Your GitHub Access Token>`
You'll need to get a [GitHub Access Token](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) with a `repo` and `user` scope and save it in the Repo Secrets `GH_TOKEN = <Your GitHub Access Token>`
Aqui está um exemplo do arquivo com o Workflow para executa-lo:
Here is Sample Workflow File for running it:
```yml
name: Waka Readme
@@ -99,8 +99,8 @@ jobs:
```
## Extras
1. Caso queira adicionar outras informações em suas estatísticas, você pode adicionar multiplas `FLAGS` no arquivo de workflow. Por padrão, todas as flags estão habilitadas
>Exceto a flag de linhas de códigos devido ao peso de seu processamento
1. If you want to add the other info to your stats, you can add multiple `FLAGS` in your workflow file by default all flags are enabled
>except the lines of code flag due to heavy operation performed
```yml
- uses: anmol098/waka-readme-stats@master
@@ -111,52 +111,52 @@ jobs:
SHOW_PROJECTS: "False"
```
### Flags Disponíveis
### Flags Available
---
`LOCALE` Essa Flag pode ser usada para mostrar as estatísticas em sua língua, o padrão é Inglês, use Locale [Forma Abreviada](https://saimana.com/list-of-country-locale-code/) para atribuir a variável na flag. Um exemplo do resultado final pode ser econtrado [aqui](https://github.com/anmol098/anmol098/blob/master/Readme-fr.md)
`LOCALE` This Flag can be used to show stats in your language default is english uses Locale [Short Hand](https://saimana.com/list-of-country-locale-code/) to be passed in the flag variable example of the final result can be found [here](https://github.com/anmol098/anmol098/blob/master/Readme-fr.md)
`SHOW_LINES_OF_CODE` essa flag pode ser configurada para `True` para mostrar as linhas de códigos escritas até a data atual
`SHOW_LINES_OF_CODE` flag can be set to `True` to show the Lines of code writen till date
![Linhas de Códigos](https://img.shields.io/badge/Desde%20o%20Hello%20World%20Eu%20Escrevi-1.3%20milhões%20de%20Linhas%20de%20Código-blue)
![Lines of code](https://img.shields.io/badge/From%20Hello%20World%20I've%20written-1.3%20million%20Lines%20of%20code-blue)
`SHOW_PROFILE_VIEWS` essa flag pode ser configurada para `False` para ocultar as Vizualizações do Perfil
`SHOW_PROFILE_VIEWS` flag can be set to `False` to hide the Profile views
![Vizualizações do Perfil](http://img.shields.io/badge/Vizualizações%20do%20Perfil-2189-blue)
![Profile Views](http://img.shields.io/badge/Profile%20Views-2189-blue)
`SHOW_COMMIT` essa flag pode ser configurada para `False` para ocultar as estatísticas de commits
`SHOW_COMMIT` flag can be set to `False` to hide the commit stats
**Eu sou Diurno 🐤**
**I'm an early 🐤**
```text
🌞 Manhã 95 commits ███████░░░░░░░░░░░░░░░░░░ 30.55%
🌆 Tarde 78 commits ██████░░░░░░░░░░░░░░░░░░░ 25.08%
🌃 Noite 112 commits █████████░░░░░░░░░░░░░░░░ 36.01%
🌙 Madrugada 26 commits ██░░░░░░░░░░░░░░░░░░░░░░░ 8.36%
🌞 Morning 95 commits ███████░░░░░░░░░░░░░░░░░░ 30.55%
🌆 Daytime 78 commits ██████░░░░░░░░░░░░░░░░░░░ 25.08%
🌃 Evening 112 commits █████████░░░░░░░░░░░░░░░░ 36.01%
🌙 Night 26 commits ██░░░░░░░░░░░░░░░░░░░░░░░ 8.36%
```
`SHOW_DAYS_OF_WEEK` essa flag pode ser configurada para `False` para ocultar os commits feitos em diferentes dias da semana
`SHOW_DAYS_OF_WEEK` flag can be set to `False` to hide the commits made on different days of week
📅 **Eu Sou Mais Produtivo aos Domingos**
📅 **I'm Most Productive on Sundays**
```text
Segunda-Feira 50 commits ███░░░░░░░░░░░░░░░░░░░░░░ 13.19%
Terça-Feira 85 commits █████░░░░░░░░░░░░░░░░░░░░ 22.43%
Quarta-Feira 56 commits ███░░░░░░░░░░░░░░░░░░░░░░ 14.78%
Quinta-Feira 44 commits ███░░░░░░░░░░░░░░░░░░░░░░ 11.61%
Sexta-Feira 28 commits █░░░░░░░░░░░░░░░░░░░░░░░░ 7.39%
Sábado 30 commits ██░░░░░░░░░░░░░░░░░░░░░░░ 7.92%
Domingo 86 commits █████░░░░░░░░░░░░░░░░░░░░ 22.69%
Monday 50 commits ███░░░░░░░░░░░░░░░░░░░░░░ 13.19%
Tuesday 85 commits █████░░░░░░░░░░░░░░░░░░░░ 22.43%
Wednesday 56 commits ███░░░░░░░░░░░░░░░░░░░░░░ 14.78%
Thursday 44 commits ███░░░░░░░░░░░░░░░░░░░░░░ 11.61%
Friday 28 commits █░░░░░░░░░░░░░░░░░░░░░░░░ 7.39%
Saturday 30 commits ██░░░░░░░░░░░░░░░░░░░░░░░ 7.92%
Sunday 86 commits █████░░░░░░░░░░░░░░░░░░░░ 22.69%
```
`SHOW_LANGUAGE` essa flag pode ser configurada para `False` para ocultar as linguagens de programação que você usa
`SHOW_LANGUAGE` flag can be set to `False` to hide the Coding Language You use
```text
💬 Linguagens de Programação:
💬 Languages:
JavaScript 5 hrs 26 mins ███████████████░░░░░░░░░░ 61.97%
PHP 1 hr 35 mins ████░░░░░░░░░░░░░░░░░░░░░ 18.07%
Markdown 1 hr 9 mins ███░░░░░░░░░░░░░░░░░░░░░░ 13.3%
@@ -165,17 +165,17 @@ XML 8 mins ░░░░░░░░░░░
```
`SHOW_OS` essa flag pode ser configurada para `False` para ocultar os detalhes do sistema operacional
`SHOW_OS` flag can be set to `False` to hide the OS details
```text
💻 Sistemas Operacionais:
💻 Operating Systems:
Windows 8 hrs 46 mins █████████████████████████ 100.0%
```
`SHOW_PROJECTS` essa flag pode ser configurada para `False` para ocultar os Projetos que você trabalhou
`SHOW_PROJECTS` flag can be set to `False` to hide the Projects worked on
```text
🐱‍💻 Projetos:
🐱‍💻 Projects:
ctx_connector 4 hrs 3 mins ███████████░░░░░░░░░░░░░░ 46.33%
NetSuite-Connector 1 hr 31 mins ████░░░░░░░░░░░░░░░░░░░░░ 17.29%
mango-web-master 1 hr 12 mins ███░░░░░░░░░░░░░░░░░░░░░░ 13.77%
@@ -183,24 +183,24 @@ cable 54 mins ██░░░░░░░░░
denAPI 40 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 7.66%
```
`SHOW_TIMEZONE` essa flag pode ser configurada para `False` para ocultar o fuso horário em que você está
`SHOW_TIMEZONE` flag can be set to `False` to hide the time zone you are in
```text
⌚︎ Fuso horário: America/Sao_Paulo
⌚︎ Timezone: Asia/Calcutta
```
`SHOW_EDITORS` essa flag pode ser configurada para `False` para ocultar os editores de códigos usados
`SHOW_EDITORS` flag can be set to `False` to hide the list of code-editors used
```text
🔥 Editores:
🔥 Editors:
WebStorm 6 hrs 47 mins ███████████████████░░░░░░ 77.43%
PhpStorm 1 hr 35 mins ████░░░░░░░░░░░░░░░░░░░░░ 18.07%
PyCharm 23 mins █░░░░░░░░░░░░░░░░░░░░░░░░ 4.49%
```
`SHOW_LANGUAGE_PER_REPO` essa flag pode ser configurada para `False` para ocultar o número de repositórios com linguagens e frameworks diferentes
`SHOW_LANGUAGE_PER_REPO` flag can be set to `False` to hide the Number of repository in different language and frameworks
**Eu geralmente programo em Vue**
**I mostly code in Vue**
```text
Vue 8 repos ██████░░░░░░░░░░░░░░░░░░░ 25.0%
@@ -213,58 +213,59 @@ CSS 2 repos █░░░░░░░░░░░░░░░░
```
`SHOW_SHORT_INFO` essa flag pode ser configurada para `False` para ocultar pequenas informações sobre o usuário
>Essa seção requer um token pessoal de acesso com permissão de usuário, caso contrário, os dados mostrados aqui estarão incorretos
`SHOW_SHORT_INFO` flag can be set to `False` to hide the short fun fact info of user
>This section requires personal access token with user permission otherwise data shown will be incorrect here
**🐱 Meus Dados no GitHub**
**🐱 My GitHub Data**
> 🏆 433 Contribuições no ano de 2020
> 🏆 433 Contributions in year 2020
>
> 📦 Usado 292.3 kB no armazenamento do GitHub
> 📦 Used 292.3 kB in GitHub's Storage
>
> 💼 Aberto para contratação
> 💼 Opted to Hire
>
> 📜 25 Repositórios Públicos
> 📜 25 Public Repository
>
> 🔑 15 Repositórios Privados
> 🔑 15 Owned Private Repository
`SHOW_LOC_CHART` essa flag pode ser configurada para `False` para ocultar as linhas de códigos escritas em diferentes trimestres do ano
`SHOW_LOC_CHART` flag can be set to `False` to hide the Lines of code written in different quarters of different year
**Linha do Tempo**
**Timeline**
![Gráfico não Encontrado](https://raw.githubusercontent.com/anmol098/anmol098/master/charts/bar_graph.png)
![Chart not found](https://raw.githubusercontent.com/anmol098/anmol098/master/charts/bar_graph.png)
## :sparkling_heart: Apoie o Projeto
## :sparkling_heart: Support the project
Eu uso código aberto em quase tudo que eu posso, e eu tento responder a todos que estão precisando de ajuda usando esse projeto. Óbvio que isso demanda tempo. Você pode usar esse serviço de graça.
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can use this service for free.
Entretanto, caso você esteja usando esse projeto e esteja feliz com isso ou apenas quer me incentivar a continuar criando soluções, tem algumas maneiras em que você pode fazer isso:-
However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-
- Dando créditos a mim quando usar essa ação no seu readme, e linkando-o de volta para esse repositório :D
- Dando uma star e compartilhando o projeto :rocket:
- [![paypal.me/aapreneur](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/aapreneur) - Você pode fazer uma doação via PayPal. Eu provávelmente irei comprar ~~cerveja~~ vinho 🍷
- Giving proper credit when you use this action on your readme, linking back to it :D
- Starring and sharing the project :rocket:
- [![paypal.me/aapreneur](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/aapreneur) - You can make one-time donations via PayPal. I'll probably buy a ~~beer~~ wine 🍷
Obrigado! :heart:
Thanks! :heart:
---
# Contribuições
# Contributing
Contribuições são bem vindas! ♥! Por favor compartilhe qualquer funcionalidade e adicione testes unitários! Use o sistema de pull request e issue para contribuir.
Contributions are welcome! ♥! Please share any features, and add unit tests! Use the pull request and issue systems to contribute.
# Contribuidores Selecionados
# Selected Contributors
1. [Anmol Pratap Singh](https://github.com/anmol098): Mantenedor
2. [Prabhat Singh](https://github.com/prabhatdev): Pelo gráfico de linha do tempo de código [#18](https://github.com/anmol098/waka-readme-stats/pull/18)
3. [Hedy Li](https://github.com/hedythedev): Pelo Pull Request [#34](https://github.com/anmol098/waka-readme-stats/pull/34) e [#23](https://github.com/anmol098/waka-readme-stats/pull/23)
4. [Pedro Torres](https://github.com/Corfucinas): Pelo Pull Request [#29](https://github.com/anmol098/waka-readme-stats/pull/29)
5. [Aaron Meese](https://github.com/ajmeese7): Pelo Pull Request [#45](https://github.com/anmol098/waka-readme-stats/pull/45)
6. [Arnav Jindal](https://github.com/Daggy1234): Pelo Pull Request [#48](https://github.com/anmol098/waka-readme-stats/pull/48)
7. [Daniel Rowe](https://github.com/DanRowe): Pelo Pull Request [#57](https://github.com/anmol098/waka-readme-stats/pull/57)
8. [Ss5h](https://github.com/tlatkdgus1): Por adicionar suporte de escrita de frase natural para tradução [#136](https://github.com/anmol098/waka-readme-stats/pull/136)
1. [Anmol Pratap Singh](https://github.com/anmol098): Maintainer
2. [Prabhat Singh](https://github.com/prabhatdev): For code timeline graph [#18](https://github.com/anmol098/waka-readme-stats/pull/18)
3. [Hedy Li](https://github.com/hedythedev): For Pull Request [#34](https://github.com/anmol098/waka-readme-stats/pull/34) and [#23](https://github.com/anmol098/waka-readme-stats/pull/23)
4. [Pedro Torres](https://github.com/Corfucinas): For Pull Request [#29](https://github.com/anmol098/waka-readme-stats/pull/29)
5. [Aaron Meese](https://github.com/ajmeese7): For Pull Request [#45](https://github.com/anmol098/waka-readme-stats/pull/45)
6. [Arnav Jindal](https://github.com/Daggy1234): For Pull Request [#48](https://github.com/anmol098/waka-readme-stats/pull/48)
7. [Daniel Rowe](https://github.com/DanRowe): For Pull Request [#57](https://github.com/anmol098/waka-readme-stats/pull/57)
8. [Ss5h](https://github.com/tlatkdgus1): For adding support for natural sentence writing for translatio [#136](https://github.com/anmol098/waka-readme-stats/pull/136)
<details>
<summary>Menção especial para aqueles que estão atualmente deixando seus readmes mais incríveis :smile: :tada:</summary>
<summary>Special mention for those who are currently making their profile readme more awesome :smile: :tada:</summary>
- [Stanislas](https://github.com/angristan)
@@ -366,14 +367,14 @@ Contribuições são bem vindas! ♥! Por favor compartilhe qualquer funcionalid
</details>
- E você! Caso esteja usando isso agora e seu nome não esteja na lista, por favor contacte-nos enviando um [Menção Especial](https://github.com/anmol098/waka-readme-stats/issues/new/choose) issue :blush: nós ficaremos gratos em adicionar você na lista.
- And you! If ever you are using it right now and you are not on the list please tell us by sending a [Special Mention](https://github.com/anmol098/waka-readme-stats/issues/new/choose) issue :blush: we are glad to add you in the list.
Feito com :heart: e Python 🐍.
Made with :heart: and Python 🐍.
# Inspirado por
# Inspired From
> [Awesome Pinned Gists](https://github.com/matchai/awesome-pinned-gists) <br/>
> [athul/waka-readme](https://github.com/athul/waka-readme)
### Esse projeto precisa de uma **star** ⭐ sua ♥.
### This project need a **star** ⭐ from you ♥.