From 2917fbde1dfa0c871a8242b4182f784a63fe9e5c Mon Sep 17 00:00:00 2001 From: pheralb Date: Wed, 3 May 2023 20:00:20 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=8D=EF=B8=8F=20Update=20readme.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 55 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 31 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index a8bd14d..c8b78e8 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,29 @@
- +

-🔎 Discover -  •   -🚀 Getting Started -  •   -🐦 Twitter +Explore +  ❖   +Getting Started +  ❖   +License +  ❖   +VSCode Theme +[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fpheralb%2Freact-symbols%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/pheralb/react-symbols/goto?ref=main) ![GitHub releases](https://img.shields.io/github/release/pheralb/react-symbols) ![GitHub stars](https://img.shields.io/github/stars/pheralb/react-symbols) ![GitHub issues](https://img.shields.io/github/issues/pheralb/react-symbols) ![GitHub license](https://img.shields.io/github/license/pheralb/react-symbols) -[![Required Node.JS >=16.0.0](https://img.shields.io/static/v1?label=node&message=%20%3E=16.0.0&logo=node.js&color=3f893e)](https://nodejs.org/about/releases)
## 👋 Introduction -[**React-Symbols**](https://react-symbols.vercel.app/) is a library for React with the icons of the VSCode theme ["Symbols"](https://marketplace.visualstudio.com/items?itemName=miguelsolorio.symbols) by [Miguel Solorio (@miguelsolorio)](https://github.com/miguelsolorio). - -## 🎉 Features +[**React-Symbols**](https://react-symbols.vercel.app/) is a library for React with the icons of the VSCode theme ["Symbols"](https://marketplace.visualstudio.com/items?itemName=miguelsolorio.symbols) by [Miguel Solorio (@miguelsolorio)](https://github.com/miguelsolorio): - **+100** icons. - **Lightweight**. @@ -32,21 +32,21 @@ ## 🚀 Getting Started -> 🚧 React-Symbols require **React >=16.8.0**. +> React-Symbols require **React >=16.8.0**. ### - Install ```bash -# npm -> +# with npm: npm install @react-symbols/icons -# pnpm -> +# with pnpm: pnpm add @react-symbols/icons -# ultra -> +# with ultra: ultra install @react-symbols/icons -# yarn -> +# with yarn: yarn add @react-symbols/icons ``` @@ -68,26 +68,33 @@ const MyComponent = () => { export default MyComponent; ``` -
- 📀 Config for use the library in Remix. +- 📀 Config for use the library with [Remix](https://remix.run/): ```js // Add in the remix.config.js: - module.exports = { ... - serverDependenciesToBundle: ["@react-symbols/icons"], // <- + serverDependenciesToBundle: ["@react-symbols/icons"], // 👈 ... }; ``` -- [Importing ESM Packages - Remix Docs](https://remix.run/docs/en/v1/pages/gotchas#importing-esm-packages). -
+## ⚙️ Stack + +This is a [Turborepo](https://turbo.build/repo) project bootstrapped with [`create-turbo`](https://www.npmjs.com/package/create-turbo): + +**For library:** + +- [SWC](https://swc.rs/) - Rust-based platform for the Web. +- [React 18](https://reactjs.org/) - A JavaScript library for building user interfaces. +- [Typescript](https://www.typescriptlang.org/) - Typed JavaScript at Any Scale. -## 📦 Icons +**For website:** -- ✅ [Icons/files](https://github.com/miguelsolorio/vscode-symbols/tree/main/src/icons/files). -- 🧩 [Icons/folders](https://github.com/miguelsolorio/vscode-symbols/tree/main/src/icons/folders). +- [Remix](https://remix.run/) - Create modern, resilient user experiences with web fundamentals. +- [Typescript](https://www.typescriptlang.org/) - Typed JavaScript at Any Scale. +- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework for rapidly building custom designs. +- [react-hot-toast](https://react-hot-toast.com/) - Beautifully React notifications. ## 🙌 Contributing