From 5c88b293873788556c91d33c5acb12e5fe9d8cee Mon Sep 17 00:00:00 2001 From: pheralb Date: Mon, 8 Sep 2025 12:35:08 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20readme,=20add=20getting?= =?UTF-8?q?-started=20with=20API,=20improve=20header=20links=20&=20add=20f?= =?UTF-8?q?ramer=20extension?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 134 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 93 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 689d819..de35765 100644 --- a/README.md +++ b/README.md @@ -10,25 +10,29 @@ Explore  ✦  - - Request logo + + Sponsor this project  ✦  - Submit logo + Getting Started  ✦  - + Extensions  ✦  - - API + + Stack  ✦  - + Contributing +  ✦  + + License +

@@ -48,50 +52,51 @@ ## 📦 Extensions -A list of extensions that use the [svgl API](https://svgl.app/api), created by the community: +A list of extensions that use the [**SVGL API**](https://svgl.app/docs/api), created by the community: -| | Extension | Description | Created by | Link | -| ---------------------------------------------------------------------------------------------------------- | ---------------------- | --------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| | SVGL CLI | A CLI for easily adding SVG icons to your project. | [sujjeee](https://twitter.com/sujjeeee) | [GitHub Repository](https://github.com/sujjeee/svgls) | -| | SVGL for React | An open-source NPM package that offers a SVGL Logos for React. | [ridemountainpig](https://x.com/ridemountainpig) | [GitHub Repository](https://github.com/ridemountainpig/svgl-react?tab=readme-ov-file#svgl-react) | -| | SVGL for Vue | An open-source NPM package that offers a SVGL Logos for Vue. | [selemondev](https://x.com/selemondev) | [GitHub Repository](https://github.com/selemondev/svgl-vue?tab=readme-ov-file#--svgl-vue--) | -| | SVGL for Svelte | An open-source NPM package that offers a SVGL Logos for Svelte. | [selemondev](https://x.com/selemondev) | [GitHub Repository](https://github.com/selemondev/svgl-svelte#--svgl-svelte--) | -| | SVGL for Figma | Add svgs from svgl to your Figma project. | [quilljou](https://twitter.com/quillzhou) | [Figma Plugin](https://www.figma.com/community/plugin/1320306989350693206/svgl) | -| | SVGL for PowerToys | Search & copy SVG logos in PowerToys Run. | [SameerJS6](https://x.com/Sameerjs6) | [Website](https://svgl.sameerjs.com/) | -| | SVGL for Raycast | Search SVG logos via svgl. | [1weiho](https://twitter.com/1weiho) | [Raycast Store](https://www.raycast.com/1weiho/svgl) | -| | SVGL for VSCode | SVGL directly in your VSCode. | [girlazote](https://twitter.com/girlazote) | [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=EsteveSegura.svgl) | -| | SVGL Badge | A beautiful badges with svgl SVG logos. | [ridemountainpig](https://twitter.com/ridemountainpig) | [Website](https://svgl-badge.vercel.app/) | -| | Magic | AI extension for Cursor & other IDEs | [serafimcloud](https://x.com/serafimcloud) | [Website](https://21st.dev/magic) | -| | SVGL for PowerShell | PowerShell extension to quickly get svgl logos anywhere | [Bart Spaans](https://bsky.app/profile/bartspaans.bsky.social) | [GitHub](https://github.com/spaansba/SVGL-PowerShell) | -| | SVGL for Flow Launcher | Search & copy SVG logos in Flow Launcher | [AF_Askar](https://x.com/Askar_AF) | [GitHub](https://github.com/abo3skr2019/SVGl-plugin) | +| | Extension | Description | Created by | Link | +| ---------------------------------------------------------------------------------------------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| | SVGL CLI | A CLI for easily adding SVG icons to your project. | [sujjeee](https://twitter.com/sujjeeee) | [GitHub Repository](https://github.com/sujjeee/svgls) | +| | SVGL for Framer | Our SVGL plugin for Framer simplifies the use of SVG-based colourful logos. Easily import and easy to use. | [Krishna Singh](https://x.com/krishnasinghdev) | [Framer Marketplace](https://www.framer.com/marketplace/plugins/svgl/) | +| | SVGL for React | An open-source NPM package that offers a SVGL Logos for React. | [ridemountainpig](https://x.com/ridemountainpig) | [GitHub Repository](https://github.com/ridemountainpig/svgl-react?tab=readme-ov-file#svgl-react) | +| | SVGL for Vue | An open-source NPM package that offers a SVGL Logos for Vue. | [selemondev](https://x.com/selemondev) | [GitHub Repository](https://github.com/selemondev/svgl-vue?tab=readme-ov-file#--svgl-vue--) | +| | SVGL for Svelte | An open-source NPM package that offers a SVGL Logos for Svelte. | [selemondev](https://x.com/selemondev) | [GitHub Repository](https://github.com/selemondev/svgl-svelte#--svgl-svelte--) | +| | SVGL for Figma | Add svgs from svgl to your Figma project. | [quilljou](https://twitter.com/quillzhou) | [Figma Plugin](https://www.figma.com/community/plugin/1320306989350693206/svgl) | +| | SVGL for PowerToys | Search & copy SVG logos in PowerToys Run. | [SameerJS6](https://x.com/Sameerjs6) | [Website](https://svgl.sameerjs.com/) | +| | SVGL for Raycast | Search SVG logos via svgl. | [1weiho](https://twitter.com/1weiho) | [Raycast Store](https://www.raycast.com/1weiho/svgl) | +| | SVGL for VSCode | SVGL directly in your VSCode. | [girlazote](https://twitter.com/girlazote) | [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=EsteveSegura.svgl) | +| | SVGL Badge | A beautiful badges with svgl SVG logos. | [ridemountainpig](https://twitter.com/ridemountainpig) | [Website](https://svgl-badge.vercel.app/) | +| | Magic | AI extension for Cursor & other IDEs | [serafimcloud](https://x.com/serafimcloud) | [Website](https://21st.dev/magic) | +| | SVGL for PowerShell | PowerShell extension to quickly get svgl logos anywhere | [Bart Spaans](https://bsky.app/profile/bartspaans.bsky.social) | [GitHub Repository](https://github.com/spaansba/SVGL-PowerShell) | +| | SVGL for Flow Launcher | Search & copy SVG logos in Flow Launcher | [AF_Askar](https://x.com/Askar_AF) | [GitHub Repository](https://github.com/abo3skr2019/SVGl-plugin) | ## 🛠️ Stack -- [**Sveltekit**](https://kit.svelte.dev/) - Web development, streamlined. +- [**Sveltekit** + **Svelte 5**](https://kit.svelte.dev/) - Web development, streamlined. - [**Typescript**](https://www.typescriptlang.org/) - JavaScript with syntax for types. -- [**mdsvex**](https://mdsvex.com/) - Markdown for Svelte apps. +- [**Content-Collections**](https://www.content-collections.dev/) - Transform your content into type-safe data collections and say goodbye to manual data fetching and parsing. - [**Shiki**](https://github.com/shikijs/shiki) - A beautiful Syntax Highlighter. -- [**Tailwindcss**](https://tailwindcss.com/) - A utility-first CSS framework for rapidly building custom designs. +- [**Tailwind CSS**](https://tailwindcss.com/) - A utility-first CSS framework for rapidly building custom designs. - [**bits-ui**](https://www.bits-ui.com) - A collection of headless components for Svelte. - [**clsx**](https://github.com/lukeed/clsx) + [**tailwind-merge**](https://github.com/dcastil/tailwind-merge) inspired by [shadcn/ui](https://ui.shadcn.com) - A tiny utility for constructing `className` strings conditionally. - [**Prettier**](https://prettier.io/) + [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss) - An opinionated code formatter. -- [**Lucide Icons**](https://lucide.dev/) + [**phosphor-svelte**](https://github.com/haruaki07/phosphor-svelte) - A clean and friendly icons libraries. +- [**Lucide Icons**](https://lucide.dev/) - Beautiful & + consistent icons. - [**svelte-sonner**](https://github.com/wobsoriano/svelte-sonner) - An opinionated toast component for Svelte. -- [**@svgr/core**](https://react-svgr.com/) - Node.js utility to transform SVGs into React components. +- [**Hono**](https://hono.dev/) - Fast, lightweight, built on Web Standards. Support for any JavaScript runtime. - [**@upstash/redis** + **@upstash/ratelimit**](https://upstash.com/) - Serverless Redis for developers. -- [**Vitest**](https://vitest.dev/) - Blazing Fast Unit Test Framework. ## 🚀 Getting Started > [!IMPORTANT] -> Before submitting the SVG, **make sure that you have permission** or that the license of the SVG allows you to add it to svgl. If you are not sure, please contact the company or author. +> Before submitting an SVG, ensure you have the right to use it and that its license permits adding it to svgl. If you are uncertain, please contact the author or the company. You will need: -- [Node.js 18+ (recommended 20 LTS)](https://nodejs.org/en/). +- [Node.js 20+](https://nodejs.org/en/). - [Git](https://git-scm.com/). -1. [Fork](https://github.com/pheralb/svgl/fork) this repository and clone it locally: +1. [**Fork this repository**](https://github.com/pheralb/svgl/fork) and clone it locally: ```bash git clone git@github.com:your_username/svgl.git @@ -128,7 +133,7 @@ pnpm install } ``` -- **Logo + wordmark** version: +- **Simple logo + wordmark**: ```ts { @@ -140,7 +145,35 @@ pnpm install } ``` -- **Logo + wordmark** & **light + dark mode**: +- **Logo (light & dark mode)**: + +```ts +{ + title: 'Title', + category: 'Category', + route: { + light: '/library/your_logo_light.svg', + dark: '/library/your_logo_dark.svg' + }, + url: 'Website' +} +``` + +- **Wordmark (light & dark mode)**: + +```ts +{ + title: 'Title', + category: 'Category', + wordmark: { + light: '/library/your_logo_light.svg', + dark: '/library/your_logo_dark.svg' + }, + url: 'Website' +} +``` + +- **Full example with all properties**: ```ts { @@ -151,14 +184,14 @@ pnpm install dark: '/library/your_logo_dark.svg' }, wordmark: { - light: '/library/your_wordmark-logo_light.svg', - dark: '/library/your_wordmark-logo_dark.svg' + light: '/library/your_logo_wordmark_light.svg', + dark: '/library/your_logo_wordmark_dark.svg' }, url: 'Website' } ``` -- **Add brand guidelines**: +- **Add brand guidelines** (where to find the images, how to use it, colors, fonts...): ```ts { @@ -176,17 +209,36 @@ pnpm install > - 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']`. -And create a pull request with your logo 🚀. +And create a pull request with your logo ✨. -5. (Optional) If you want to run the [API](https://svgl.app/api) locally, you will need to create a `.dev.vars` file in the [`/api-routes`](https://github.com/pheralb/svgl/tree/main/api-routes) folder with the following variables: +## 🧑‍🚀 Getting Started with API + +> [!WARNING] +> This section is how to run API locally. For all API endpoints, check the [**API documentation**](https://svgl.app/api). + +1. Go to the [**`api-routes`**](https://github.com/pheralb/svgl/tree/main/api-routes) folder and install the dependencies with [pnpm](https://pnpm.io/): + +```bash +cd api-routes +pnpm install +``` + +2. Create a `.dev.vars` env file in the `api-routes` folder with the following variables: + +```bash +# .dev.vars +SVGL_API_REQUESTS = 1 +UPSTASH_REDIS_URL = "" +UPSTASH_REDIS_TOKEN = "" +``` - [Create a Upstash account](https://console.upstash.com/). - [Create a Upstash Redis Database](https://upstash.com/docs/redis/overall/getstarted). +3. Run the development server: + ```bash -SVGL_API_REQUESTS = 1 -UPSTASH_REDIS_URL = "" -UPSTASH_REDIS_TOKEN = "" +pnpm dev ``` ## ✌️ Contributing