Skip to content

Commit

Permalink
✍️ Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
pheralb committed May 3, 2023
1 parent e859d3c commit 2917fbd
Showing 1 changed file with 31 additions and 24 deletions.
55 changes: 31 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
<div align="center">
<a href="https://react-symbols.vercel.app/">
<img src="website/public/images/banner.png">
<img src="website/public/images/og_image.png">
</a>

<p></p>

<a href="https://react-symbols.vercel.app/">🔎 Discover</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="#-getting-started">🚀 Getting Started</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://twitter.com/pheralb_">🐦 Twitter</a>
<a href="https://react-symbols.vercel.app/">Explore</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="#-getting-started">Getting Started</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="#-license">License</a>
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
<a href="https://marketplace.visualstudio.com/items?itemName=miguelsolorio.symbols">VSCode Theme</a>

[![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)

</div>

## 👋 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**.
Expand All @@ -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
```

Expand All @@ -68,26 +68,33 @@ const MyComponent = () => {
export default MyComponent;
```

<details>
<summary>📀 Config for use the library in Remix.</summary>
- 📀 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).
</details>
## ⚙️ 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

Expand Down

0 comments on commit 2917fbd

Please sign in to comment.