@ppg_pl/pallete 2.0.1 → 2.0.2

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 (3) hide show
  1. package/README.md +31 -14
  2. package/package.json +1 -1
  3. package/www/index.html +1 -1
package/README.md CHANGED
@@ -1,26 +1,41 @@
1
- # Project documentation
1
+ # Project Documentation
2
2
 
3
- ## Backend to version 1.0.1
3
+ This documentation provides an overview of the project's architecture, technologies used, and integration instructions for both the backend and frontend components.
4
4
 
5
- The application is built on the [strapi](https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html) version 4.
5
+ ## Backend
6
6
 
7
- The method of collation is described in detail in the strapi documentation itself, so it is important to familiarise yourself with it.
7
+ ### Version 1.0.1
8
8
 
9
- The backend is based on node and staging is set to postgres database.
9
+ - **Framework**: The application backend is built using [Strapi](https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html) version 4.
10
+ - **Database**: The staging environment is configured with a PostgreSQL database.
11
+ - **Collation Method**: Refer to the Strapi documentation for detailed information on collation.
10
12
 
11
- ## Backend from version 2.0.0
13
+ ### Version 2.0.0
12
14
 
13
- The application is built on the [directus](https://docs.directus.io/self-hosted/quickstart.html) version 10.10.4.
15
+ - **Framework**: The application backend is built using [Directus](https://docs.directus.io/self-hosted/quickstart.html) version 10.10.4.
16
+ - **Database**: The staging environment is configured with a PostgreSQL database.
17
+ - **Collation Method**: Refer to the Directus documentation for detailed information on collation.
14
18
 
15
- The method of collation is described in detail in the directus documentation itself, so it is important to familiarise yourself with it.
19
+ ## Frontend
16
20
 
17
- The backend is based on node and staging is set to postgres database.
21
+ - **Webcomponent Library**: The frontend application is written as a webcomponent using [StencilJS](https://stenciljs.com/docs/introduction).
22
+ - **Integration**: To integrate the webcomponent into an HTML file, follow these steps:
18
23
 
19
- ## Frontend
24
+ 1. Install the package using npm:
25
+
26
+ ```
27
+ npm install @ppg_pl/pallete
28
+ ```
20
29
 
21
- The application is written as a webcomponent through this library [docs](https://stenciljs.com/docs/introduction).
30
+ or using yarn:
22
31
 
23
- It is very easy to connect the webcomponent to the html file, you have to build the application with npm run build or yarn build and connect the www folder.
32
+ ```
33
+ yarn add @ppg_pl/pallete
34
+ ```
35
+
36
+ 2. Connect the generated `www` folder to your HTML file.
37
+
38
+ 3. Ensure correct paths for assets and scripts within the HTML file. Below is an example of how to import the package into any project:
24
39
 
25
40
  ```html
26
41
  <!DOCTYPE html>
@@ -29,7 +44,7 @@ It is very easy to connect the webcomponent to the html file, you have to build
29
44
  <meta charset="UTF-8" />
30
45
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
31
46
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
32
- <title>test</title>
47
+ <title>Color Selector</title>
33
48
 
34
49
  <style type="text/css" media="screen, print">
35
50
  @font-face {
@@ -67,4 +82,6 @@ It is very easy to connect the webcomponent to the html file, you have to build
67
82
  </html>
68
83
  ```
69
84
 
70
- As far as other integrations are concerned, everything is described in the documentation
85
+ ## Additional Integrations
86
+
87
+ For other integrations and specific functionalities, refer to the comprehensive documentation provided for each component or library.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ppg_pl/pallete",
3
- "version": "2.0.1",
3
+ "version": "2.0.2",
4
4
  "description": "Color-Selector WebComponent",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.js",
package/www/index.html CHANGED
@@ -1,4 +1,4 @@
1
- <!doctype html><html dir="ltr" lang="pl"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Color Mixer</title> <style type="text/css" media="screen, print">@font-face {
1
+ <!doctype html><html dir="ltr" lang="pl"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Color Selector</title> <style type="text/css" media="screen, print">@font-face {
2
2
  font-family: 'Galatea';
3
3
  src: url(./assets/fonts/Galatea-Regular.woff2) format('woff2'), url(./assets/fonts/Galatea-Regular.woff) format('woff'),
4
4
  url(./assets/fonts/Galatea-Regular.ttf) format('truetype'), url(./assets/fonts/Galatea-Regular.eot) format('embedded-opentype');