mirror of
https://github.com/pheralb/svgl.git
synced 2024-11-10 14:46:54 +08:00
✍️ Update readme.
This commit is contained in:
parent
7fc5ec87c7
commit
4b03d1868c
43
README.md
43
README.md
@ -1,27 +1,54 @@
|
||||
<p align="center">
|
||||
<a href="https://svgl.vercel.app/">
|
||||
<img src="https://raw.githubusercontent.com/pheralb/svgl/main/public/images/banner.png" width="800px" alt="svgl preview" />
|
||||
<img src="https://i.postimg.cc/5yd46Lsb/banner.png" width="800px" alt="SVGL Banner" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## 🚀 Getting started:
|
||||
## 📦 Packages:
|
||||
|
||||
[SVGL](https://svgl.vercel.app/) is a beautiful collection of SVG logos. Free and open source.
|
||||
- ⚡️ [Nextjs](https://nextjs.org/) - The React Framework for Production.
|
||||
- ⚒️ [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces.
|
||||
- 💙 [Typescript](https://www.typescriptlang.org/) - A superset of JavaScript.
|
||||
- 💅 [Chakra UI](https://chakra-ui.com/) - Create accessible React apps with speed.
|
||||
- 💥 [Framer Motion](https://www.framer.com/motion/) - Production-ready motion library.
|
||||
- ⬇️ [next-pwa](https://github.com/shadowwalker/next-pwa) - Zero config PWA plugin for Next.js, with workbox.
|
||||
|
||||
## 🚀 Getting started:
|
||||
|
||||
You need:
|
||||
|
||||
- [Node.js 16+ (recommend: 16.14.0 LTS)](https://nodejs.org/en/)
|
||||
- [Node.js 16+ (recommend: 16.15.1 LTS)](https://nodejs.org/en/)
|
||||
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
||||
|
||||
and run:
|
||||
1. Clone the repository:
|
||||
|
||||
```bash
|
||||
git@github.com:pheralb/svgl.git
|
||||
```
|
||||
|
||||
2. Install dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
# or
|
||||
yarn install
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
3. Run:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
```
|
||||
|
||||
🥳 Open [localhost:3000](localhost:3000) with your browser to see the result.
|
||||
|
||||
## ⚒️ Shortcuts:
|
||||
|
||||
- ⭐ SVG Library: [/public/library/](https://github.com/pheralb/svgl/tree/main/public/library).
|
||||
- ✍️ SVG JSON logos: [/data/](https://github.com/pheralb/svgl/tree/main/data).
|
||||
|
||||
## 🔑 License:
|
||||
|
||||
MIT
|
||||
- [MIT](https://github.com/pheralb/svgl/blob/main/LICENSE).
|
||||
|
Loading…
Reference in New Issue
Block a user