@@ -12,6 +12,37 @@ A demo of the application is available at [https://essentials-stg.vercel.app/](h
1212* Responsive design for use on desktop and mobile devices.
1313* Comprehensive testing suite using Jest and React Testing Library.
1414
15+ ## Custom Theme Guide
16+
17+ ### Network Logo
18+
19+ Network logos should be placed in the ` /public/images/network/ ` directory with the following specifications:
20+
21+ * File Format: PNG format (transparent background recommended)
22+ * File Naming: Should match the network identifier (e.g., ` assethub-westend.png ` , ` paseo.png ` )
23+ * Design Style: Both circular or square logos are acceptable, but visual clarity should be ensured
24+
25+ Currently available network logos:
26+
27+ * ` assethub-westend.png `
28+ * ` paseo.png `
29+
30+ ### Network Banner Images
31+
32+ Network banner images should be placed in:
33+
34+ * Path: ` /public/images/banner/ `
35+ * File Format: PNG or JPG
36+ * Banner images will be displayed at the top of network pages
37+ * Design Style: Should reflect the network's characteristics and may include the network name, logo, and related visual elements
38+
39+ ### Adding New Network Images
40+
41+ 1 . Prepare image files according to the specifications above
42+ 2 . Add the network logo to ` /public/images/network/[network-id].png `
43+ 3 . Update the network banner to ` /public/images/banner/navbar.png `
44+ 4 . The application will automatically detect and display the corresponding images based on the network identifier
45+
1546## Getting Started
1647
1748### Prerequisites
@@ -21,20 +52,25 @@ A demo of the application is available at [https://essentials-stg.vercel.app/](h
2152
2253### Installation
2354
24- 1 . Clone the repository:
25- ``` bash
26- git clone https://github.com/itering/subscan-essentials-ui-react.git
27- ```
28- 2. Navigate to the project directory:
29- ` ` ` bash
30- cd subscan-essentials-ui-react
31- ` ` `
32- 3. Install dependencies:
33- ` ` ` bash
34- npm install
35- # or
36- yarn install
37- ` ` `
55+ 1 . Clone the repository:
56+
57+ ``` bash
58+ git clone https://github.com/itering/subscan-essentials-ui-react.git
59+ ```
60+
61+ 1 . Navigate to the project directory:
62+
63+ ``` bash
64+ cd subscan-essentials-ui-react
65+ ```
66+
67+ 1 . Install dependencies:
68+
69+ ``` bash
70+ npm install
71+ # or
72+ yarn install
73+ ```
3874
3975### Running the Development Server
4076
0 commit comments