Skip to content

Commit

Permalink
Change name to react-simple-devicons
Browse files Browse the repository at this point in the history
  • Loading branch information
Shane Williams committed Nov 3, 2024
1 parent 241c9a3 commit 37b8d8e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
<p align="center">
<a href="https://github.com/shawilly/simple-react-devicon/stargazers"><img src="https://img.shields.io/github/stars/shawilly/simple-react-devicon?colorA=192330&colorB=f8e7b0&style=for-the-badge"></a>
<a href="https://github.com/shawilly/simple-react-devicon/issues"><img src="https://img.shields.io/github/issues/shawilly/simple-react-devicon?colorA=192330&colorB=98d4e7&style=for-the-badge"></a>
<a href="https://github.com/shawilly/simple-react-devicon/contributors"><img src="https://img.shields.io/github/contributors/shawilly/simple-react-devicon?colorA=192330&colorB=b4e49a&style=for-the-badge"></a>
<a href="https://github.com/shawilly/simple-react-devicon/network/members"><img src="https://img.shields.io/github/forks/shawilly/simple-react-devicon?colorA=192330&colorB=bdb2ff&style=for-the-badge"></a>
<a href="https://github.com/shawilly/react-simple-devicons/stargazers"><img src="https://img.shields.io/github/stars/shawilly/react-simple-devicons?colorA=192330&colorB=f8e7b0&style=for-the-badge"></a>
<a href="https://github.com/shawilly/react-simple-devicons/issues"><img src="https://img.shields.io/github/issues/shawilly/react-simple-devicons?colorA=192330&colorB=98d4e7&style=for-the-badge"></a>
<a href="https://github.com/shawilly/react-simple-devicons/contributors"><img src="https://img.shields.io/github/contributors/shawilly/react-simple-devicons?colorA=192330&colorB=b4e49a&style=for-the-badge"></a>
<a href="https://github.com/shawilly/react-simple-devicons/network/members"><img src="https://img.shields.io/github/forks/shawilly/react-simple-devicons?colorA=192330&colorB=bdb2ff&style=for-the-badge"></a>
</p>

# simple-react-devicon
# react-simple-devicons

`simple-react-devicon` is a React component library for displaying [devicons](https://devicon.dev/) icons as SVGs, offering customizable styles, color, and scaling.
`react-simple-devicons` is a React component library for displaying [devicons](https://devicon.dev/) icons as SVGs, offering customizable styles, color, and scaling.

## Installation

To install, use your preferred package manager:

```bash
npm install simple-react-devicon
npm install react-simple-devicons
```

```bash
pnpm install simple-react-devicon
pnpm install react-simple-devicons
```

```bash
yarn add simple-react-devicon
yarn add react-simple-devicons
```

## Usage
Expand All @@ -31,7 +31,7 @@ Import the `DevIcon` component into your React application:

```tsx
import React from "react";
import { DevIcon } from "simple-react-devicon";
import { DevIcon } from "react-simple-devicons";

export default function App() {
return (
Expand Down Expand Up @@ -77,7 +77,7 @@ The `scale` prop adjusts the icon's dimensions. Here’s a list of predefined si

```tsx
import React from "react";
import { DevIcon } from "simple-react-devicon";
import { DevIcon } from "react-simple-devicons";

const App = () => {
return (
Expand Down Expand Up @@ -105,7 +105,7 @@ To learn about using Server-Side Rendering with [Next.js](https://nextjs.org/doc
First, create a component that wraps `DevIcon` (_app/devicon.tsx_):

```tsx
import { DevIcon } from "simple-react-devicon";
import { DevIcon } from "react-simple-devicons";

const DevIcon = () => {
return <DevIcon />;
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "simple-react-devicon",
"name": "react-simple-devicons",
"description": "A simple and customizable React component for displaying development icons. This package is built using TypeScript and is designed for easy integration into your React applications, providing a seamless way to showcase your development tools and technologies.",
"version": "0.1.5",
"author": {
Expand All @@ -18,7 +18,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/shawilly/simple-react-devicon"
"url": "https://github.com/shawilly/react-simple-devicons"
},
"scripts": {
"dev": "concurrently \"pnpm build --watch\" \"pnpm storybook\" \"pnpm test\" ",
Expand Down
10 changes: 5 additions & 5 deletions src/docs/PUBLISH.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 📦 Publish `simple-react-devicon` to npm
# 📦 Publish `react-simple-devicons` to npm

This guide provides instructions to publish the `simple-react-devicon` package to npm.
This guide provides instructions to publish the `react-simple-devicons` package to npm.

## Prerequisites

Expand All @@ -13,11 +13,11 @@ Ensure you have:
pnpm login
```

## Build and Publish `simple-react-devicon`
## Build and Publish `react-simple-devicons`

1. **Build the package**

Use `tsup` to bundle `simple-react-devicon` for production:
Use `tsup` to bundle `react-simple-devicons` for production:

```bash
pnpm build
Expand All @@ -44,4 +44,4 @@ Ensure you have:
- Add an npm token as a GitHub secret if using GitHub Actions for automated publishing.
- In the GitHub repository settings, enable **"Read & write permissions"** under **Actions** to ensure workflows run smoothly.

Once complete, `simple-react-devicon` will be live on npm!
Once complete, `react-simple-devicons` will be live on npm!

0 comments on commit 37b8d8e

Please sign in to comment.