From a8897f28fd5d46752f1e3b9ecd0fd1104301b671 Mon Sep 17 00:00:00 2001 From: "Vladimir Antonio F. C." <50648871+vladiantio@users.noreply.github.com> Date: Fri, 22 Aug 2025 16:19:48 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20`README.md`=20to=20chan?= =?UTF-8?q?ge=20JSON=20syntax=20to=20TypeScript=20for=20`src/data/svgs.ts`?= =?UTF-8?q?=20examples?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 0f22206..689d819 100644 --- a/README.md +++ b/README.md @@ -119,62 +119,62 @@ pnpm install - **Simple logo**: -```json +```ts { - "title": "Title", - "category": "Category", - "route": "/library/your_logo.svg", - "url": "Website" + title: 'Title', + category: 'Category', + route: '/library/your_logo.svg', + url: 'Website' } ``` - **Logo + wordmark** version: -```json +```ts { - "title": "Title", - "category": "Category", - "route": "/library/your_logo.svg", - "wordmark": "/library/your_logo_wordmark.svg", - "url": "Website" + title: 'Title', + category: 'Category', + route: '/library/your_logo.svg', + wordmark: '/library/your_logo_wordmark.svg', + url: 'Website' } ``` - **Logo + wordmark** & **light + dark mode**: -```json +```ts { - "title": "Title", - "category": "Category", - "route": { - "light": "/library/your_logo_light.svg", - "dark": "/library/your_logo_dark.svg" + title: 'Title', + category: 'Category', + route: { + light: '/library/your_logo_light.svg', + dark: '/library/your_logo_dark.svg' }, - "wordmark": { - "light": "/library/your_wordmark-logo_light.svg", - "dark": "/library/your_wordmark-logo_dark.svg" + wordmark: { + light: '/library/your_wordmark-logo_light.svg', + dark: '/library/your_wordmark-logo_dark.svg' }, - "url": "Website" + url: 'Website' } ``` - **Add brand guidelines**: -```json +```ts { - "title": "Title", - "category": "Category", - "route": "/library/your_logo.svg", - "wordmark": "/library/your_logo_wordmark.svg", - "brandUrl": "https://assets.website.com/brand-guidelines", - "url": "Website" + title: 'Title', + category: 'Category', + route: '/library/your_logo.svg', + wordmark: '/library/your_logo_wordmark.svg', + brandUrl: 'https://assets.website.com/brand-guidelines', + url: 'Website' } ``` > [!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. -> - 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 🚀.