Skip to content

Commit fccc020

Browse files
authored
Merge pull request #746 from vladiantio/fix/readme-change-json-to-ts
📝 Update README.md to change JSON syntax to TS for `src/data/svgs.ts` examples
2 parents 0c39c86 + a8897f2 commit fccc020

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -119,62 +119,62 @@ pnpm install
119119

120120
- **Simple logo**:
121121

122-
```json
122+
```ts
123123
{
124-
"title": "Title",
125-
"category": "Category",
126-
"route": "/library/your_logo.svg",
127-
"url": "Website"
124+
title: 'Title',
125+
category: 'Category',
126+
route: '/library/your_logo.svg',
127+
url: 'Website'
128128
}
129129
```
130130

131131
- **Logo + wordmark** version:
132132

133-
```json
133+
```ts
134134
{
135-
"title": "Title",
136-
"category": "Category",
137-
"route": "/library/your_logo.svg",
138-
"wordmark": "/library/your_logo_wordmark.svg",
139-
"url": "Website"
135+
title: 'Title',
136+
category: 'Category',
137+
route: '/library/your_logo.svg',
138+
wordmark: '/library/your_logo_wordmark.svg',
139+
url: 'Website'
140140
}
141141
```
142142

143143
- **Logo + wordmark** & **light + dark mode**:
144144

145-
```json
145+
```ts
146146
{
147-
"title": "Title",
148-
"category": "Category",
149-
"route": {
150-
"light": "/library/your_logo_light.svg",
151-
"dark": "/library/your_logo_dark.svg"
147+
title: 'Title',
148+
category: 'Category',
149+
route: {
150+
light: '/library/your_logo_light.svg',
151+
dark: '/library/your_logo_dark.svg'
152152
},
153-
"wordmark": {
154-
"light": "/library/your_wordmark-logo_light.svg",
155-
"dark": "/library/your_wordmark-logo_dark.svg"
153+
wordmark: {
154+
light: '/library/your_wordmark-logo_light.svg',
155+
dark: '/library/your_wordmark-logo_dark.svg'
156156
},
157-
"url": "Website"
157+
url: 'Website'
158158
}
159159
```
160160

161161
- **Add brand guidelines**:
162162

163-
```json
163+
```ts
164164
{
165-
"title": "Title",
166-
"category": "Category",
167-
"route": "/library/your_logo.svg",
168-
"wordmark": "/library/your_logo_wordmark.svg",
169-
"brandUrl": "https://assets.website.com/brand-guidelines",
170-
"url": "Website"
165+
title: 'Title',
166+
category: 'Category',
167+
route: '/library/your_logo.svg',
168+
wordmark: '/library/your_logo_wordmark.svg',
169+
brandUrl: 'https://assets.website.com/brand-guidelines',
170+
url: 'Website'
171171
}
172172
```
173173

174174
> [!NOTE]
175175
>
176176
> - The list of categories is here: [`src/types/categories.ts`](https://github.com/pheralb/svgl/blob/main/src/types/categories.ts). You can add a new category if you need it.
177-
> - You can add multiple categories to the same logo, for example: `"category": ["Social", "Design"]`.
177+
> - You can add multiple categories to the same logo, for example: `category: ['Social', 'Design']`.
178178
179179
And create a pull request with your logo 🚀.
180180

0 commit comments

Comments
 (0)