@kanmu/popcorn-icons 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -15
  2. package/package.json +2 -3
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @kanmu/popcorn-icons
2
2
 
3
- カンムの React Native で開発されたプロダクトで使用するアイコンライブラリ
3
+ Popcorn (Vandle Design System) で使用するアイコンライブラリ
4
4
 
5
5
  ## インストール
6
6
 
@@ -20,6 +20,11 @@ yarn add react-native-svg
20
20
 
21
21
  ## 使い方
22
22
 
23
+ すべてのアイコンコンポーネントは以下のデフォルト値を持ちます。
24
+
25
+ - サイズ: `24`(幅・高さ)
26
+ - 色: `currentColor`(親要素のテキスト色を継承)
27
+
23
28
  ### 基本的な使用例
24
29
 
25
30
  ```tsx
@@ -65,20 +70,27 @@ const CustomizedIcons = () => {
65
70
  );
66
71
  };
67
72
 
68
- const styles = StyleSheet.create({
69
- container: {
70
- flexDirection: 'row',
71
- gap: 16,
72
- },
73
- iconButton: {
74
- width: 48,
75
- height: 48,
76
- alignItems: 'center',
77
- justifyContent: 'center',
78
- },
79
- });
73
+ // その他の react-native-svg の Props も使用可能
74
+ <Icon name="check" opacity={0.5} />
75
+
76
+ // style も適用可能
77
+ <Icon name="check" style={{marginRight: 8}} />
80
78
  ```
81
79
 
82
- ## 作成者
80
+ ## Contributing
81
+
82
+ アイコンパッケージの開発に貢献したい方は、以下のドキュメントを参照してください。
83
+
84
+ - [コントリビューションガイド](../../CONTRIBUTING.md) - 開発環境のセットアップとワークフロー
85
+ - [リリースガイド](./docs/release-guide.md) - Figma からアイコンを更新してリリースする手順
86
+
87
+ ## ライセンスと使用上の注意
88
+
89
+ ### 基本ライセンス
90
+
91
+ このパッケージのコードとほとんどのアイコンは MIT License の下で提供されています。
92
+
93
+ ### ブランドアイコン(商標)の例外
83
94
 
84
- Kanmu Design Team
95
+ 一部のブランドアイコンは商標として保護されており、以下の使用制限があります。
96
+ 詳細および保護対象のアイコン一覧については [LICENSE.md](./LICENSE.md) をご確認ください。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kanmu/popcorn-icons",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "Popcorn Icons for React Native.",
5
5
  "license": "UNLICENSED",
6
6
  "author": "Kanmu Design Team",
@@ -45,6 +45,5 @@
45
45
  "@types/react": {
46
46
  "optional": true
47
47
  }
48
- },
49
- "packageManager": "yarn@3.8.7"
48
+ }
50
49
  }