Skip to content

Commit ec55bdc

Browse files
committed
docs: small change
1 parent 326b15c commit ec55bdc

File tree

5 files changed

+52
-69
lines changed

5 files changed

+52
-69
lines changed

.editorconfig

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,7 @@ insert_final_newline = true
1818
# No whitespace at the end of line
1919
trim_trailing_whitespace = true
2020

21-
# ================================================
22-
# 4 SPACE INDENTATION
23-
# ================================================
24-
25-
[{Makefile,**.mk}]
26-
indent_size = 4
27-
indent_style = tab
28-
29-
# ================================================
30-
# 2 SPACE INDENTATION
31-
# ================================================
32-
33-
[*.{md,Rmd,rst}]
34-
trim_trailing_whitespace = false
35-
36-
# ================================================
37-
# GO INDENTATION
38-
# ================================================
39-
40-
[*.{go,tmpl,html}]
41-
indent_style = tab
21+
# JSON files
22+
[*.json]
23+
# Each indent should contain 4 spaces for Python files
24+
indent_size = 2

.gitignore

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -39,25 +39,6 @@ completions
3939
# Stores VSCode versions used for testing VSCode extensions
4040
.vscode-test
4141

42-
# ================================================
43-
# NODE
44-
# ================================================
45-
46-
npm-debug.log*
47-
48-
# Dependency directories
49-
node_modules/
50-
51-
# ================================================
52-
# YARN
53-
# ================================================
54-
55-
yarn-debug.log*
56-
yarn-error.log*
57-
58-
/.pnp
59-
.pnp.js
60-
6142
# ================================================
6243
# GOLANG
6344
# ================================================

.go-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.19.2
1+
1.23.5

README.md

Lines changed: 46 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,19 @@
11
<!-- BEGIN_DOCS -->
22
<div align="center">
33

4-
<img alt="gif-header" src="https://c.tenor.com/PX2XATCduFcAAAAC/loli.gif" width="225"/>
4+
<a name="readme-top"></a>
55

6-
<h2>Loli CLI</h2>
7-
8-
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://www.conventionalcommits.org/en/v1.0.0/) [![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://semantic-release.gitbook.io/semantic-release/usage/configuration) [![Built with Devbox](https://jetpack.io/img/devbox/shield_galaxy.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)
6+
**Loli CLI**
97

108
<img alt="pipelines" src="https://i.pinimg.com/originals/ce/26/14/ce2614ef4c70f04a2c578f972308f5b6.gif" width="250"/>
119

12-
<p>Loli is a pretty CLI that search animes passing images or links</p>
10+
Hello Humans 👽! Loli is a pretty CLI that search animes passing images or links
1311

14-
<p>
15-
<a href="#getting-started">Getting Started</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
16-
<a href="#install">Install</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
17-
<a href="#usage">Usage</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
18-
<a href="#versioning">Versioning</a>
19-
</p>
12+
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://www.conventionalcommits.org/en/v1.0.0/) [![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://semantic-release.gitbook.io/semantic-release/usage/configuration) [![Built with Devbox](https://jetpack.io/img/devbox/shield_galaxy.svg)](https://jetpack.io/devbox/docs/contributor-quickstart/)
2013

2114
</div>
2215

23-
## Getting Started <a name = "getting-started"></a>
16+
# Getting Started
2417

2518
If you want contribute on this project, first you need to make a **git clone**:
2619

@@ -30,11 +23,13 @@ git clone --depth 1 https://github.com/ci-monk/loli.git -b main
3023

3124
This will give you access to the code on your **local machine**.
3225

33-
## ➤ Description <a name = "description"></a>
26+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
27+
28+
# Description
3429

3530
This **CLI** is intended to be a code lab and best practices for creating a project ready to receive community builds, while introducing the basics for creating a **CLI** tool in **Go** and the standardization of conventions for the development workflow.
3631

37-
## Install <a name = "install"></a>
32+
# Install
3833

3934
with `go`:
4035

@@ -55,21 +50,25 @@ brew install loli
5550

5651
or use a binary from [releases](https://github.com/ci-monk/loli/releases/latest).
5752

58-
## ➤ Usage <a name = "usage"></a>
53+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
5954

60-
### Get anime with a file
55+
# Usage
56+
57+
## Get anime with a file
6158

6259
```bash
6360
loli search file anime.jpg
6461
```
6562

66-
### Get anime with a link
63+
## Get anime with a link
6764

6865
```bash
6966
loli search link https://anime.com/image.png
7067
```
7168

72-
## ➤ Trace.moe <a name = "trace.moe"></a>
69+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
70+
71+
# Trace.moe
7372

7473
Example trace.moe response:
7574

@@ -102,29 +101,50 @@ Example trace.moe response:
102101
}
103102
```
104103

105-
## ➤ Demo <a name = "demo"></a>
104+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
105+
106+
# Demo
106107

107108
https://user-images.githubusercontent.com/58797390/192595643-a27003a5-d0ba-4abf-b8bb-19f449398190.mov
108109

109-
## ➤ Links <a name = "links"></a>
110+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
111+
112+
# Referências
113+
114+
Links relevantes para essa documentação:
110115

111116
- https://soruly.github.io/trace.moe-api/#/
112117
- https://img.olhardigital.com.br/wp-content/uploads/2021/07/Naruto-Classico-e-Naruto-Shippuden-fillers.jpg
113118
- https://images.plurk.com/32B15UXxymfSMwKGTObY5e.jpg
114119

115-
## ➤ Versioning <a name = "versioning"></a>
120+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
121+
122+
# Versionamento
123+
124+
Para verificar o histórico de mudanças, acesse o arquivo [**CHANGELOG.md**](CHANGELOG.md).
125+
126+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
116127

117-
To check the change history, please access the [**CHANGELOG.md**](CHANGELOG.md) file.
128+
# Troubleshooting
118129

119-
## ➤ Show your support <a name = "show-your-support"></a>
130+
Se você tiver algum problema ou queria contribuir, abra uma [issue](https://github.com/lpsm-dev/loli/issues/new/choose) nesse projeto.
131+
132+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
133+
134+
# Show your support
120135

121136
<div align="center">
122137

123-
Give me a ⭐️ if you like this project!
138+
Dê uma ⭐️ para este projeto se ele te ajudou!
124139

125-
<img alt="gif-footer" src="https://github.com/lpsm-dev/lpsm-dev/blob/main/.github/assets/yoda.gif" width="225"/>
140+
<img alt="gif-footer" src="https://github.com/lpsm-dev/lpsm-dev/blob/0062b174ec9877e6dfc78817f314b4a0690f63ff/.github/assets/yoda.gif" width="225"/>
126141

127-
Made with 💜 by [me](https://github.com/ci-monk) :wave: inspired on [readme-md-generator](https://github.com/kefranabg/readme-md-generator)
142+
<br>
143+
<br>
144+
145+
Feito com 💜 pelo **Time de DevOps** :wave: inspirado no [readme-md-generator](https://github.com/kefranabg/readme-md-generator)
128146

129147
</div>
148+
149+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
130150
<!-- END_DOCS -->

scripts/completions.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
#!/bin/sh
22
set -e
33

4-
rm -rf completions
5-
mkdir completions
4+
rm -rf completions && mkdir completions
65

76
for sh in bash zsh fish; do
87
go run ./cmd/loli/main.go completion "$sh" >"completions/loli.$sh"

0 commit comments

Comments
 (0)