Skip to content

Commit

Permalink
docs: change description
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucca Pessoa committed Aug 16, 2021
1 parent 9c33f41 commit 1c86b21
Showing 1 changed file with 49 additions and 1 deletion.
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</p>

<p align="center">
G-Earth + G-Python allows you to create simple scripts for Habbo and run them on the fly!
A simple tool to make some stuffs with G-Earth
</p>

<p align="center">
Expand All @@ -40,6 +40,54 @@ 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**.

## ➤ Prerequisites <a name = "prerequisites"></a>

Before you start developing on this project you need to install some tools on your **local machine**:

### Develop tools

- **python**

### Support tools

- **pre-commit**

For more information, access the [CONTRIBUTING](CONTRIBUTING.md) file.

## ➤ Installing <a name = "installing"></a>

To install support dependencies that handle commit and release standards, run the command:

```bash
make install
```

This shareable configuration use the following dependencies:

-[Semantic Release](https://github.com/semantic-release) + Plugins de configuração
- [`semantic-release`](https://github.com/semantic-release/semantic-release)
- [`@semantic-release/git`](https://github.com/semantic-release/git)
- [`@semantic-release/github`](https://github.com/semantic-release/github)
- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
-[Commit Lint](https://github.com/conventional-changelog/commitlint) usando o [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
- [`commitizen`](https://github.com/commitizen/cz-cli)
- [`@commitlint/cli`](https://github.com/conventional-changelog/commitlint)
- [`@commitlint/config-conventional`](https://github.com/conventional-changelog/commitlint)

For more information, access the [CONTRIBUTING](CONTRIBUTING.md) file.

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

<div align="center">

<p align="center">
<img alt="gif-description" src="https://media3.giphy.com/media/5ziQ5kjh4lgCd29WOR/200w.gif?cid=82a1493b0uufgvz9tw6byen3bed3y7h9u0ilzpcuthz7a5ne&rid=200w.gif" width="250px" float="center"/>
</p>

</div>

## ➤ Links <a name = "links"></a>

- https://sulek.dev/api
Expand Down

0 comments on commit 1c86b21

Please sign in to comment.