qyg2297248353/svgl
qyg2297248353/svgl
1
0
Fork 0
mirror of https://github.com/pheralb/svgl.git synced 2025-02-06 15:17:58 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

📝 Update readme docs.

Browse Source
This commit is contained in:
pheralb 2023-12-17 14:53:11 +00:00
parent d51d9cf238
commit bee957c3a9
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -62,20 +62,20 @@ You will need:
- [Node.js 16+ (recommended 18 LTS)](https://nodejs.org/en/). - [Node.js 16+ (recommended 18 LTS)](https://nodejs.org/en/).
- [Git](https://git-scm.com/). - [Git](https://git-scm.com/).
1. Clone or [fork](https://github.com/pheralb/svgl/fork) this repository: 1. [Fork](https://github.com/pheralb/svgl/fork) this repository and clone it locally:
```bash ```bash
git clone git@github.com:pheralb/svgl.git git clone git@github.com:your_username/svgl.git
``` ```
2. Install dependencies: 2. Install dependencies:
```bash ```bash
# with pnpm (recommended): # Install pnpm globally if you don't have it:
pnpm install npm install -g pnpm
# with npm: # and install dependencies:
npm install pnpm install
``` ```
3. Go to the [**`static/library`**](https://github.com/pheralb/svgl/blob/main/static/library) folder and add your `.svg` logo. 3. Go to the [**`static/library`**](https://github.com/pheralb/svgl/blob/main/static/library) folder and add your `.svg` logo.
@ -115,6 +115,16 @@ 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:
- [Create a Upstash account](https://console.upstash.com/).
```bash
SVGL_API_REQUESTS = 1
UPSTASH_REDIS_URL = ""
UPSTASH_REDIS_TOKEN = ""
```
## 💻 Terminal ## 💻 Terminal
SVG files can also be accessed directly from the terminal using [`svgls`](https://www.npmjs.com/package/svgls) CLI. SVG files can also be accessed directly from the terminal using [`svgls`](https://www.npmjs.com/package/svgls) CLI.