Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
VampireAotD committed Dec 28, 2024
1 parent 81384e1 commit e7e2fb8
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
<img src="art/logo.svg" alt="Anilibrary logo" style="width: 75%">
</p>

Application for scraping anime data from different supported sites

[![Frontend build](https://github.com/VampireAotD/anilibrary/actions/workflows/frontend-build.yml/badge.svg)](https://github.com/VampireAotD/anilibrary/actions/workflows/frontend-build.yml)
[![Backend build](https://github.com/VampireAotD/anilibrary/actions/workflows/backend-build.yml/badge.svg)](https://github.com/VampireAotD/anilibrary/actions/workflows/backend-build.yml)

:warning: This project has a lot more to improve, for example: code base, working with other services, frontend part,
and, in time, it all **will be improved**, but for now, **Anilibrary is not considered stable, breaking changes will
occur, so for now - it need to be used for development purposes only!**
> [!WARNING]
> This project has a lot more to improve, for example: code base, working with other services, frontend part,
> and, in time, it all **will be improved**, but for now, **Anilibrary is not considered stable, breaking changes will
> occur, so for now - it need to be used for development purposes only!**
---

Expand Down Expand Up @@ -119,12 +118,20 @@ To do that you can use different commands, for example, to run static analysis u
make phpstan
```

```sh
make eslint-check
```

To ensure that project has same code style use:

```sh
make pint
```

```sh
make prettier-fix
```

To make life easier and automatically run all this commands for you before commit, **Git hooks** are used. To run them,
**Anilibrary** uses [Lefthook](https://github.com/evilmartians/lefthook), so you must install it as well.

Expand Down

0 comments on commit e7e2fb8

Please sign in to comment.