groovinads-ui 1.9.94 → 1.9.95

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.
package/README.md CHANGED
@@ -82,6 +82,78 @@ Instead, they should be included in the `index.html` file of your project. This
82
82
 
83
83
  # Installation
84
84
 
85
+ ## 1. Configure FontAwesome Pro Access
86
+
87
+ This library requires **FontAwesome Pro** packages. Before installing, you need to configure access to the FontAwesome Pro registry.
88
+
89
+ ### For Yarn Berry (v2+) users:
90
+
91
+ Create or update `.yarnrc.yml` in your project root:
92
+
93
+ ```yaml
94
+ npmScopes:
95
+ fortawesome:
96
+ npmAlwaysAuth: true
97
+ npmRegistryServer: "https://npm.fontawesome.com/"
98
+ npmAuthToken: "YOUR_FONTAWESOME_TOKEN_HERE"
99
+ awesome.me:
100
+ npmAlwaysAuth: true
101
+ npmRegistryServer: "https://npm.fontawesome.com/"
102
+ npmAuthToken: "YOUR_FONTAWESOME_TOKEN_HERE"
103
+ ```
104
+
105
+ ### For npm and Yarn Classic (v1.x) users:
106
+
107
+ Create or update `.npmrc` in your project root:
108
+
109
+ ```
110
+ @fortawesome:registry=https://npm.fontawesome.com/
111
+ @awesome.me:registry=https://npm.fontawesome.com/
112
+ //npm.fontawesome.com/:_authToken=YOUR_FONTAWESOME_TOKEN_HERE
113
+ ```
114
+
115
+ Replace `YOUR_FONTAWESOME_TOKEN_HERE` with your FontAwesome Pro token (available at https://fontawesome.com/account).
116
+
117
+ **Note:** This library is for internal use only and requires a valid FontAwesome Pro license.
118
+
119
+ **Important:** Check your Yarn version with `yarn --version`:
120
+ - If you see `1.x.x`, use the `.npmrc` file
121
+ - If you see `2.x.x` or higher, use the `.yarnrc.yml` file
122
+
123
+ ## 2. Install Required Dependencies
124
+
125
+ This library requires several peer dependencies. Install them first:
126
+
127
+ ```bash
128
+ # For npm users
129
+ npm install @awesome.me/kit-9889deefc5@^1.0.3 \
130
+ @fortawesome/fontawesome-svg-core@^7.1.0 \
131
+ @fortawesome/free-brands-svg-icons@^7.1.0 \
132
+ @fortawesome/duotone-regular-svg-icons@^7.1.0 \
133
+ @fortawesome/pro-duotone-svg-icons@^7.1.0 \
134
+ @fortawesome/pro-regular-svg-icons@^7.1.0 \
135
+ @fortawesome/pro-solid-svg-icons@^7.1.0 \
136
+ @fortawesome/react-fontawesome@^3.1.1 \
137
+ react-datepicker@^7.3.0 \
138
+ react-loading-skeleton@^3.5.0 \
139
+ react-responsive@^10.0.0
140
+
141
+ # For Yarn users
142
+ yarn add @awesome.me/kit-9889deefc5@^1.0.3 \
143
+ @fortawesome/fontawesome-svg-core@^7.1.0 \
144
+ @fortawesome/free-brands-svg-icons@^7.1.0 \
145
+ @fortawesome/duotone-regular-svg-icons@^7.1.0 \
146
+ @fortawesome/pro-duotone-svg-icons@^7.1.0 \
147
+ @fortawesome/pro-regular-svg-icons@^7.1.0 \
148
+ @fortawesome/pro-solid-svg-icons@^7.1.0 \
149
+ @fortawesome/react-fontawesome@^3.1.1 \
150
+ react-datepicker@^7.3.0 \
151
+ react-loading-skeleton@^3.5.0 \
152
+ react-responsive@^10.0.0
153
+ ```
154
+
155
+ ## 3. Install the Library
156
+
85
157
  To use the Groovinads UI library in your project, run the following command:
86
158
 
87
159
  ```bash