From 37b8d8e85eea668db2384de287f864725df9fd16 Mon Sep 17 00:00:00 2001 From: Shane Williams Date: Sun, 3 Nov 2024 10:50:18 +0000 Subject: [PATCH] Change name to react-simple-devicons --- README.md | 24 ++++++++++++------------ package.json | 4 ++-- src/docs/PUBLISH.md | 10 +++++----- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4f5c0f8..d10354e 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,28 @@

- - - - + + + +

-# 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 @@ -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 ( @@ -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 ( @@ -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 ; diff --git a/package.json b/package.json index 85a2da5..c6d90e5 100644 --- a/package.json +++ b/package.json @@ -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": { @@ -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\" ", diff --git a/src/docs/PUBLISH.md b/src/docs/PUBLISH.md index 4d3ea3e..e532b47 100644 --- a/src/docs/PUBLISH.md +++ b/src/docs/PUBLISH.md @@ -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 @@ -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 @@ -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!