From 8a895cbb32a444f36c5f48f5a0de5a3771c75abb Mon Sep 17 00:00:00 2001 From: pheralb Date: Thu, 22 Aug 2024 16:43:44 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Update=20readme=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 84f3972..d5202eb 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ You will need: -- [Node.js 16+ (recommended 18 LTS)](https://nodejs.org/en/). +- [Node.js 18+ (recommended 20 LTS)](https://nodejs.org/en/). - [Git](https://git-scm.com/). 1. [Fork](https://github.com/pheralb/svgl/fork) this repository and clone it locally: @@ -97,7 +97,7 @@ pnpm install 4. Go to the [**`src/data/svgs.ts`**](https://github.com/pheralb/svgl/blob/main/src/data/svgs.ts) and add the information about your logo, following the structure: -- If the logo is a solid color: +- **Simple logo**: ```json { @@ -108,7 +108,7 @@ pnpm install } ``` -- If the logo has logo + wordmark version: +- **Logo + wordmark** version: ```json { @@ -120,7 +120,7 @@ pnpm install } ``` -- If the logo/wordmark has light and dark mode: +- **Logo + wordmark** & **light + dark mode**: ```json { @@ -141,7 +141,7 @@ pnpm install > [!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"]` (max 3 categories per logo). +> - You can add multiple categories to the same logo, for example: `"category": ["Social", "Design"]`. And create a pull request with your logo 🚀.