From 238f8d8619e728666c698348714cdd4034d90cd2 Mon Sep 17 00:00:00 2001 From: pheralb Date: Thu, 28 Dec 2023 11:35:45 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20readme=20docs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 ++++++++++++------------------ 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e7e90c8..88add11 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,12 @@ Submit logo  ✦  - - Terminal + + Extensions  ✦  - - Contact + + API  ✦  @@ -120,9 +120,10 @@ or to support a different logo for light and dark themes: And create a pull request with your logo 🚀. -5. (Optional) If you want to run the API locally, you will need to create a `.env` file in the root of the project with the following variables: +5. (Optional) If you want to run the [API](https://svgl.app/api) locally, you will need to create a `.env` file in the root of the project with the following variables: - [Create a Upstash account](https://console.upstash.com/). +- [Create a Upstash Redis Database](https://upstash.com/docs/redis/overall/getstarted). ```bash SVGL_API_REQUESTS = 1 @@ -130,21 +131,14 @@ UPSTASH_REDIS_URL = "" UPSTASH_REDIS_TOKEN = "" ``` -## 💻 Terminal +## 📦 Extensions -SVG files can also be accessed directly from the terminal using [`svgls`](https://www.npmjs.com/package/svgls) CLI. +A list of extensions that use the [svgl API](https://svgl.app/api), created by the community: -#### Quick start - -If you are using yarn or npm, run this command: - -```bash -npx svgls add -# or -pnpm dlx svgls add -``` - -For more details, check out the [GitHub repository](https://github.com/sujjeee/svgls) created by [sujjeee](https://twitter.com/sujjeeee). +| Extension | Description | Created by | Link | +| -------------- | -------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------- | +| svgls | A CLI for easily adding SVG icons to your project. | [sujjeee](https://twitter.com/sujjeeee) | [Repository](https://github.com/sujjeee/svgls) | +| 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) | ## ✌️ Contributing