Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cristian-Sknz authored May 16, 2022
1 parent c03388c commit c965f3d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,24 @@ Chrome/Opera extension to romanize Japanese song lyrics on Spotify
## Features

- [] Chrome Web Store
- [ ] Chrome Web Store
- [x] Romanize Spotify lyrics
- [] Loading indicating that romanization is taking place.
- [] Option to disable romanization
- [] Follow the browser extension design pattern
- [ ] Loading indicating that romanization is taking place.
- [ ] Option to disable romanization
- [ ] Follow the browser extension design pattern

## Installation

1. Download the latest release here on Github
1. Download the [latest release](https://github.com/Cristian-Sknz/kashi-extension/releases) here on Github
2. Choose the type you want to use:
- `Light` this version is lighter, as it does not use the packages for romanization, but it may take longer to romanize the letters.
- `Dict` this version is heavier, as it uses a packages for romanization, but the letters are romanized instantly.
3. After completing the previous steps...
1. Go to [_chrome://extensions_](chrome://extensions) in Google Chrome or `extensions` in Opera
2. With the developer mode checkbox ticked, click **Load unpacked extension...** and select the _extracted folder_.

<img src="https://user-images.githubusercontent.com/61399406/168503678-9dd58841-61f6-400e-9c38-39e149ce5b99.png" width="800">

## Development

Use `npm install` or `yarn install` to install the dependencies, you will have to use an editor that supports Typescript.
Use `npm install` or `yarn install` to install the dependencies, you will have to use an editor that supports Typescript.

0 comments on commit c965f3d

Please sign in to comment.