qyg2297248353/svgl
qyg2297248353/svgl
1
0
Fork 0
mirror of https://github.com/pheralb/svgl.git synced 2024-11-14 09:11:54 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

📝 Update readme docs.

Browse Source
This commit is contained in:
pheralb 2023-12-28 11:35:45 +00:00
parent 0ae8b654e1
commit 238f8d8619
1 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -14,12 +14,12 @@
Submit logo Submit logo
</a> </a>
<span>&nbsp;✦&nbsp;</span> <span>&nbsp;✦&nbsp;</span>
<a href="#-terminal"> <a href="#-extensions">
Terminal Extensions
</a> </a>
<span>&nbsp;✦&nbsp;</span> <span>&nbsp;✦&nbsp;</span>
<a href="https://twitter.com/pheralb_"> <a href="https://svgl.app/api">
Contact API
</a> </a>
<span>&nbsp;✦&nbsp;</span> <span>&nbsp;✦&nbsp;</span>
<a href="#%EF%B8%8F-contributing"> <a href="#%EF%B8%8F-contributing">
@ -120,9 +120,10 @@ or to support a different logo for light and dark themes:
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 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 account](https://console.upstash.com/).
- [Create a Upstash Redis Database](https://upstash.com/docs/redis/overall/getstarted).
```bash ```bash
SVGL_API_REQUESTS = 1 SVGL_API_REQUESTS = 1
@ -130,21 +131,14 @@ UPSTASH_REDIS_URL = ""
UPSTASH_REDIS_TOKEN = "" 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 | Extension | Description | Created by | Link |
| -------------- | -------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------- |
If you are using yarn or npm, run this command: | 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) |
```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).
## ✌️ Contributing ## ✌️ Contributing