Skip to content

Commit

Permalink
doc: add hook install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhykos committed Nov 1, 2024
1 parent db46971 commit 01eec7c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,13 @@ autophoto --publish --bluesky_login=your_login --bluesky_password=your_password

### Install the project

#### Deno

Deno is a runtime for JavaScript and TypeScript that is based on the V8 JavaScript engine and the Rust programming language.
You need to install Deno to run the project: https://docs.deno.com/runtime/getting_started/installation/.

#### Lint and format

Activate the lint and format with Biome:

```shell
Expand All @@ -147,6 +152,16 @@ You'll be able to run the format with the following command:
deno task format
```

#### Git hooks

You can install the git hooks with the following command:

```shell
deno task hook install
```

It will run the linter and tests before each commit.

### Run the project

There is no run configuration for the project because I just used unit tests to develop the project.
Expand Down

0 comments on commit 01eec7c

Please sign in to comment.