Skip to content

Commit

Permalink
chore: update project information
Browse files Browse the repository at this point in the history
  • Loading branch information
aiktb committed Oct 18, 2024
1 parent 93accc7 commit 1aa9b6c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
12 changes: 11 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,14 @@ In order to test browser extensions, playwright needs to use the `headless=new`

```bash
pnpm test:e2e
```
```

### Lint

```bash
pnpm run lint:fix
```

You may see a message saying "These CSS classes should be sorted", please ignore it.

This project integrates biome (linter and formatter) in git hook, which will trigger automatic fix of this error when committing, then you need to use `git commit ---amead`.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,8 @@ If you like this project, please consider supporting me by buying me a coffee.
## License

[MIT](./LICENSE) | © 2023 [aiktb](https://aiktb.dev) made with ❤️.

## Thanks

- Inspired by [mirigana](https://github.com/mirigana/mirigana) and [AdGuard](https://github.com/AdguardTeam/AdguardBrowserExtension).
- Core features are based on [kuromoji](https://github.com/sglkc/kuromoji.js).
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
},
"private": true,
"license": "MIT",
"author": "aiktb <hey@aiktb.dev>",
"author": {
"name": "Jaguar Zhou",
"email": "ai.ourship@gmail.com"
},
"homepage": "https://furiganamaker.app",
"repository": {
"type": "git",
Expand Down

0 comments on commit 1aa9b6c

Please sign in to comment.