Skip to content

Commit 4841bc9

Browse files
authored
Merge pull request #14 from NaverPayDev/update/README
update README
2 parents ada6454 + 71fb456 commit 4841bc9

4 files changed

Lines changed: 149 additions & 3 deletions

File tree

.changeset/spotty-trees-pick.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@naverpay/browserslist-config": patch
3+
---
4+
5+
update README
6+
7+
PR: [update README](https://github.com/NaverPayDev/browserslist-config/pull/14)

README.ko.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# @naverpay/browserslist-config
2+
3+
> @naverpay/frontend의 공식 [Browserslist](https://browsersl.ist) 공유 설정 패키지
4+
5+
## 소개
6+
7+
이 패키지는 NAVERPAY 프론트엔드가 개발한 서비스에서 사용할 **공식 지원 브라우저/Node.js 버전** 목록을 일관되게 관리할 수 있는 환경을 제공합니다.
8+
9+
**Current support range:**
10+
[>0.2%, not dead, not op_mini all, not ie >= 0, not ios_saf < 15, ios_saf >= 15, node >= 18.18.0, Chrome >= 106](https://browsersl.ist/#q=%3E0.2%25%2Cnot+dead%2Cnot+op_mini+all%2Cnot+ie%3E%3D0%2Cnot+ios_saf%3C15%2Cios_saf%3E%3D15%2Cnode%3E%3D18.18.0%2CChrome%3E%3D106&region=KR)
11+
12+
## 설치
13+
14+
```bash
15+
npm install --save-dev @naverpay/browserslist-config
16+
# 또는
17+
yarn add -D @naverpay/browserslist-config
18+
# 또는
19+
pnpm add -D @naverpay/browserslist-config
20+
```
21+
22+
## 사용법
23+
24+
### `package.json`에서 사용
25+
26+
```json
27+
{
28+
"browserslist": ["extends @naverpay/browserslist-config"]
29+
}
30+
```
31+
32+
### `.browserslistrc`파일에서 사용
33+
34+
```
35+
extends @naverpay/browserslist-config
36+
```
37+
38+
## Targets
39+
40+
- 전 세계 점유율 0.2% 이상 브라우저
41+
- 사용량이 거의 없는(dead) 브라우저 제외
42+
- Internet Explorer, Opera Mini, iOS Safari 15 미만 제외
43+
- iOS Safari 15 이상 포함
44+
- Node.js 18.18.0 이상
45+
- Chrome 106 이상
46+
47+
최신 지원 브라우저 전체 리스트는 아래에서 확인할 수 있습니다.
48+
[browsersl.ist 쿼리 (KR)](https://browsersl.ist/#q=%3E0.2%25%2Cnot+dead%2Cnot+op_mini+all%2Cnot+ie%3E%3D0%2Cnot+ios_saf%3C15%2Cios_saf%3E%3D15%2Cnode%3E%3D18.18.0%2CChrome%3E%3D106&region=KR)
49+
50+
## 자주 묻는 질문
51+
52+
**Q: 왜 공유 설정을 사용하나요?**
53+
A: 모든 NAVERPAY 프론트엔드가 동일한 브라우저 정책을 따르도록 보장하며, 설정 중복과 실수를 방지합니다.
54+
55+
**Q: 업데이트 주기는?**
56+
A: 비즈니스/프로젝트의 요구나 브라우저의 시장환경 변화에 따라 변경됩니다. 자세한 변경사항은 CHANGELOG를 참고하세요.
57+
58+
**Q: 실제 지원 브라우저를 확인하려면?**
59+
A:
60+
61+
```bash
62+
npx browserslist
63+
```
64+
65+
또는 위 링크의 [browsersl.ist](https://browsersl.ist)에서 직접 확인할 수 있습니다.
66+
67+
## 라이선스
68+
69+
ISC

README.md

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,69 @@
1-
# browserslist-config
1+
# @naverpay/browserslist-config
22

3-
Shareable Browserslist config for @naverpay/frontend
3+
> Shareable [Browserslist](https://browsersl.ist) configuration for @naverpay/frontend
44
5-
지원범위: [>0.2%,not dead,not op_mini all,not ie>=0,not ios_saf<15,ios_saf>=15,node>=18.18.0,Chrome>=106](https://browsersl.ist/#q=%3E0.2%25%2Cnot+dead%2Cnot+op_mini+all%2Cnot+ie%3E%3D0%2Cnot+ios_saf%3C15%2Cios_saf%3E%3D15%2Cnode%3E%3D18.18.0%2CChrome%3E%3D106&region=KR)
5+
## Overview
6+
7+
This package provides a unified and maintainable list of supported browsers and Node.js versions for all NAVERPAY frontend services.
8+
9+
**Current support range:**
10+
[>0.2%, not dead, not op_mini all, not ie >= 0, not ios_saf < 15, ios_saf >= 15, node >= 18.18.0, Chrome >= 106](https://browsersl.ist/#q=%3E0.2%25%2Cnot+dead%2Cnot+op_mini+all%2Cnot+ie%3E%3D0%2Cnot+ios_saf%3C15%2Cios_saf%3E%3D15%2Cnode%3E%3D18.18.0%2CChrome%3E%3D106&region=KR)
11+
12+
## Installation
13+
14+
```bash
15+
npm install --save-dev @naverpay/browserslist-config
16+
# or
17+
yarn add -D @naverpay/browserslist-config
18+
# or
19+
pnpm add -D @naverpay/browserslist-config
20+
```
21+
22+
## Usage
23+
24+
### In your `package.json`
25+
26+
```json
27+
{
28+
"browserslist": ["extends @naverpay/browserslist-config"]
29+
}
30+
```
31+
32+
### Or in a `.browserslistrc` file
33+
34+
```
35+
extends @naverpay/browserslist-config
36+
```
37+
38+
## Targets
39+
40+
- Browsers with >0.2% market share
41+
- Excludes browsers with no global usage ("dead")
42+
- Excludes Internet Explorer, Opera Mini, iOS Safari below 15
43+
- Includes iOS Safari 15+
44+
- Node.js 18.18.0+
45+
- Chrome 106+
46+
47+
See the full, up-to-date list here:
48+
[browsersl.ist Query (KR)](https://browsersl.ist/#q=%3E0.2%25%2Cnot+dead%2Cnot+op_mini+all%2Cnot+ie%3E%3D0%2Cnot+ios_saf%3C15%2Cios_saf%3E%3D15%2Cnode%3E%3D18.18.0%2CChrome%3E%3D106&region=KR)
49+
50+
## FAQ
51+
52+
**Q: Why use a shared Browserslist config?**
53+
A: It ensures every @naverpay/frontend project follows the same browser support policy—less redundancy, fewer mistakes.
54+
55+
**Q: How often is it updated?**
56+
A: As the business/project requirements or browser landscape changes. Check CHANGELOG for details.
57+
58+
**Q: How do I check the resolved browser list?**
59+
A:
60+
61+
```bash
62+
npx browserslist
63+
```
64+
65+
Or use [browsersl.ist](https://browsersl.ist) with the query above.
66+
67+
## License
68+
69+
ISC

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
"description": "Shareable Browserslist config for naverpay",
55
"main": "index.js",
66
"types": "index.d.ts",
7+
"files": [
8+
"dist",
9+
"README.md",
10+
"README.ko.md",
11+
"CHANGELOG.md"
12+
],
713
"scripts": {
814
"release": "changeset publish",
915
"changeset-version": "changeset version",

0 commit comments

Comments
 (0)