Skip to content

Commit

Permalink
docs: add new topcis
Browse files Browse the repository at this point in the history
  • Loading branch information
lpsm-dev committed Jun 17, 2022
1 parent 9fe80ba commit 3b8582c
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@

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

<p>
✨ Loli is a pretty CLI that find animes passing images - inspiration in <a href="https://github.com/irevenko/what-anime-cli">what-anime-cli</a> ✨
</p>
<p>✨ Loli is a pretty CLI that search animes passing images or links using trace.moe API ✨</p>

<p>
<a href="#getting-started">Getting Started</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
Expand All @@ -35,10 +33,24 @@ If you want contribute on this project, first you need to make a **git clone**:
This will give you access to the code on your **local machine**.

## ➤ Installation <a name = "installation"></a>

```bash
go install github.com/ci-monk/loli/cmd/loli

# if you cannot install directly, try following command,
# then input install command again
go get -x -u github.com/ci-monk/loli/cmd/loli
```

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

## ➤ Description <a name = "description"></a>

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.

## ➤ Learning <a name = "learning"></a>

In this process, I gained experiences in the following topics regarding the Go language:

- ✔️ Discover internal Go packages like: `os`, `string` and `fmt`.
Expand All @@ -54,6 +66,8 @@ In this process, I gained experiences in the following topics regarding the Go l
- ✔️ Use conditional in compilation and build tags.
- ✔️ How to build CLI using Go

## ➤ Trace.moe <a name = "trace.moe"></a>

Example trace.moe response:

```json
Expand Down Expand Up @@ -81,18 +95,6 @@ Example trace.moe response:
}
```

## ➤ Installation <a name = "installation"></a>

```bash
go install github.com/ci-monk/loli/cmd/loli

# if you cannot install directly, try following command,
# then input install command again
go get -x -u github.com/ci-monk/loli/cmd/loli
```

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

## ➤ Development with docker


Expand Down Expand Up @@ -180,10 +182,6 @@ Depending on what you are making, it can be a good idea to include screenshots o

To check the change history, please access the [**CHANGELOG.md**](CHANGELOG.md) file.

## ➤ Project status <a name = "project-status"></a>

This project is currently undergoing a reorganization 👾.

## ➤ Show your support <a name = "show-your-support"></a>

<div align="center">
Expand Down

0 comments on commit 3b8582c

Please sign in to comment.