Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaewoook committed Jun 23, 2024
1 parent 7398101 commit 994c772
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,30 @@

## ๋ฐ๋ชจ

์ฃผ์†Œ๊ฒ€์ƒ‰ ํ™•์žฅ ํ”„๋กœ๊ทธ๋žจ์˜ ์‚ฌ์šฉ ๋ฐ๋ชจ์ž…๋‹ˆ๋‹ค.

![Demo GIF](/images/demo.gif)

## ์ง€์› ๋ธŒ๋ผ์šฐ์ €

| ๋ธŒ๋ผ์šฐ์ € | ์ƒํƒœ | |
|---------------|:------------------:|------------------------|
์ž์‹ ์˜ ๋ธŒ๋ผ์šฐ์ €์— ํ™•์žฅ ํ”„๋กœ๊ทธ๋žจ ์Šคํ† ์–ด์—์„œ ๋ฐ”๋กœ ๋‹ค์šด๋กœ๋“œํ•˜์„ธ์š”!

| ๋ธŒ๋ผ์šฐ์ € | ์ƒํƒœ | ๋‹ค์šด๋กœ๋“œ |
|--------|:---:|-------|
| Google Chrome | :heavy_check_mark: | [ํฌ๋กฌ ์›น ์Šคํ† ์–ด์—์„œ ๋‹ค์šด๋กœ๋“œ](https://chrome.google.com/webstore/detail/%EC%A3%BC%EC%86%8C%EA%B2%80%EC%83%89/kiamcbcponnlbnanbbfnfdjhioebpiah) |
| NAVER Whale | :heavy_check_mark: | [์›จ์ผ ์Šคํ† ์–ด์—์„œ ๋‹ค์šด๋กœ๋“œ](https://store.whale.naver.com/detail/pidjpaocfolbbaminggjijheckcdfcdj) |
| Mozilla Firefox | :warning: | ~~[Firefox Add-ons์—์„œ ๋‹ค์šด๋กœ๋“œ](https://addons.mozilla.org/ko/firefox/addon/kor-address-extension/)~~ |

#### (๋น„๊ณต์‹) ๊ทธ ์™ธ ๋ธŒ๋ผ์šฐ์ €
### ๊ธฐํƒ€ ๋ธŒ๋ผ์šฐ์ €

์•„๋ž˜ **"์ˆ˜๋™์œผ๋กœ ์„ค์น˜ํ•˜๊ธฐ"** ์˜ ๊ณตํ†ต ์„น์…˜๊ณผ ๋ธŒ๋ผ์šฐ์ €๋ณ„ ํ™•์žฅ ํ”„๋กœ๊ทธ๋žจ ์„ค์น˜ ๋ฐฉ๋ฒ• ์ฐธ์กฐ
์Šคํ† ์–ด์—์„œ ์•„๋ž˜ **์ˆ˜๋™์œผ๋กœ ์„ค์น˜ํ•˜๊ธฐ**์˜ ๊ณตํ†ต ์„น์…˜๊ณผ ๋ธŒ๋ผ์šฐ์ €๋ณ„ ํ™•์žฅ ํ”„๋กœ๊ทธ๋žจ ์„ค์น˜ ๋ฐฉ๋ฒ• ์ฐธ์กฐ

> NOTE: ๋ธŒ๋ผ์šฐ์ €๋Š” WebExtension API๋ฅผ ์ง€์›ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ฃผ์†Œ๊ฒ€์ƒ‰ ํ”„๋กœ์ ํŠธ๋Š” WebExtension spec์„ ์ค€์ˆ˜ํ•˜์ง€๋งŒ ์•ˆ์ •์ ์ธ ๋™์ž‘์„ ๋ณด์žฅํ•˜์ง€๋Š” ์•Š์Šต๋‹ˆ๋‹ค.
> [!IMPORTANT]
> ๋ธŒ๋ผ์šฐ์ €๋Š” WebExtension API๋ฅผ ์ง€์›ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. ์ฃผ์†Œ๊ฒ€์ƒ‰ ํ”„๋กœ์ ํŠธ๋Š” WebExtension spec์„ ์ค€์ˆ˜ํ•˜์ง€๋งŒ ์•ˆ์ •์ ์ธ ๋™์ž‘์„ ๋ณด์žฅํ•˜์ง€๋Š” ์•Š์Šต๋‹ˆ๋‹ค.
## ์ˆ˜๋™์œผ๋กœ ์„ค์น˜ํ•˜๊ธฐ
## ์ง์ ‘ ๋นŒ๋“œํ•˜๊ธฐ

### ์ค€๋น„ํ•˜๊ธฐ
ํ”„๋กœ์ ํŠธ ์†Œ์Šค ์ฝ”๋“œ๋ฅผ ๋กœ์ปฌ ํ™˜๊ฒฝ์— ๋‹ค์šด๋กœ๋“œ ๋ฐ›๊ณ , ์ง์ ‘ ๋นŒ๋“œํ•˜์—ฌ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋จผ์ €, ์ด ์ €์žฅ์†Œ๋ฅผ ๋‹ค์šด๋กœ๋“œ ํ•˜๊ณ  ์˜์กด์„ฑ ์„ค์น˜๋ฅผ ํ•ฉ๋‹ˆ๋‹ค.

Expand Down Expand Up @@ -63,8 +68,8 @@ yarn build && yarn package

## ์ œ์ž‘์ž

- Jaewook Ahn <ajw4586@gmail.com>
[Jaewook Ahn](https://github.com/Jaewoook)

## ์ €์ž‘๊ถŒ

MIT ([LICENSE](https://github.com/Jaewoook/kor-address-extension/blob/master/LICENSE) ํŒŒ์ผ ์ฐธ๊ณ )
์ด ํ”„๋กœ์ ํŠธ๋Š” [MIT ๋ผ์ด์„ ์Šค](./LICENSE)๋ฅผ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.

0 comments on commit 994c772

Please sign in to comment.