Merge pull request #746 from vladiantio/fix/readme-change-json-to-ts
📦 Build / 🛠️ Build app (push) Has been cancelled
🧑‍🚀 Check / ⚡ Testing with Vitest (push) Has been cancelled
🧑‍🚀 Check / 📦 SVGs Size (push) Has been cancelled
🚀 Deploy / ☁️ API (push) Has been cancelled

📝 Update README.md to change JSON syntax to TS for `src/data/svgs.ts` examples
This commit is contained in:
Pablo Hdez
2025-08-23 01:28:01 +01:00
committed by GitHub
+29 -29
View File
@@ -119,62 +119,62 @@ pnpm install
- **Simple logo**: - **Simple logo**:
```json ```ts
{ {
"title": "Title", title: 'Title',
"category": "Category", category: 'Category',
"route": "/library/your_logo.svg", route: '/library/your_logo.svg',
"url": "Website" url: 'Website'
} }
``` ```
- **Logo + wordmark** version: - **Logo + wordmark** version:
```json ```ts
{ {
"title": "Title", title: 'Title',
"category": "Category", category: 'Category',
"route": "/library/your_logo.svg", route: '/library/your_logo.svg',
"wordmark": "/library/your_logo_wordmark.svg", wordmark: '/library/your_logo_wordmark.svg',
"url": "Website" url: 'Website'
} }
``` ```
- **Logo + wordmark** & **light + dark mode**: - **Logo + wordmark** & **light + dark mode**:
```json ```ts
{ {
"title": "Title", title: 'Title',
"category": "Category", category: 'Category',
"route": { route: {
"light": "/library/your_logo_light.svg", light: '/library/your_logo_light.svg',
"dark": "/library/your_logo_dark.svg" dark: '/library/your_logo_dark.svg'
}, },
"wordmark": { wordmark: {
"light": "/library/your_wordmark-logo_light.svg", light: '/library/your_wordmark-logo_light.svg',
"dark": "/library/your_wordmark-logo_dark.svg" dark: '/library/your_wordmark-logo_dark.svg'
}, },
"url": "Website" url: 'Website'
} }
``` ```
- **Add brand guidelines**: - **Add brand guidelines**:
```json ```ts
{ {
"title": "Title", title: 'Title',
"category": "Category", category: 'Category',
"route": "/library/your_logo.svg", route: '/library/your_logo.svg',
"wordmark": "/library/your_logo_wordmark.svg", wordmark: '/library/your_logo_wordmark.svg',
"brandUrl": "https://assets.website.com/brand-guidelines", brandUrl: 'https://assets.website.com/brand-guidelines',
"url": "Website" url: 'Website'
} }
``` ```
> [!NOTE] > [!NOTE]
> >
> - 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. > - 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.
> - You can add multiple categories to the same logo, for example: `"category": ["Social", "Design"]`. > - You can add multiple categories to the same logo, for example: `category: ['Social', 'Design']`.
And create a pull request with your logo 🚀. And create a pull request with your logo 🚀.