Skip to content

Commit 2f0944b

Browse files
committed
docs: improve docs
1 parent f923363 commit 2f0944b

File tree

6 files changed

+7
-10
lines changed

6 files changed

+7
-10
lines changed

.storybook/main.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ const config: StorybookConfig = {
4242
: ""
4343
}
4444
<meta name="title" content="react-install-command" />
45-
<meta name="description" content="A React component for rendering a 'npm install <package name>' command block. Supports multiple package managers and themes. Drop it into your MDX code, a ShadCN UI component, a Tailwind codebase, use our built in styles or go unstyled. You choose." />
45+
<meta name="description" content="A React component for rendering a 'npm install package-name' command block. Supports multiple package managers and themes. Drop it into your MDX code, a ShadCN UI component, a Tailwind codebase, use built-in styles or go unstyled. You choose." />
4646
`,
4747
};
4848
export default config;

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# 📡 React Install Command
22

3-
A React component for rendering a 'npm install <package name>' code block. Supports multiple package managers and variations of install commands. Totally customizable. Drop it into an MDX file, a Shadcn component, a Tailwind codebase, use our built in styles or even go unstyled. You choose.
3+
A React component for rendering a 'npm install package-name' code block. Supports multiple package managers and variations of install commands. Totally customizable. Drop it into an MDX file, a Shadcn component, a Tailwind codebase, use built-in styles or even go unstyled. You choose.
44

55
Visit the [Storybook](https://react-install-command.vercel.app/) for examples and documentation.
66

7-
![React Command Block Demo](./docs/readme.png)
7+
![React Install Command Light](./docs/readme-light.png)
8+
9+
![React Install Command Dark](./docs/readme-dark.png)
810

911
## Features
1012

docs/readme-dark.png

23.4 KB
Loading

docs/readme-light.png

23.5 KB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-install-command",
3-
"description": "A React component for rendering a 'npm install <package name>' command block. Supports multiple package managers and themes. Drop it into your MDX code, a ShadCN UI component, a Tailwind codebase, use our built in styles or go unstyled. You choose.",
3+
"description": "A React component for rendering a 'npm install package-name' command block. Supports multiple package managers and themes. Drop it into your MDX code, a ShadCN UI component, a Tailwind codebase, use built-in styles or go unstyled. You choose.",
44
"version": "1.1.0",
55
"author": "Tim Mikeladze <[email protected]>",
66
"license": "MIT",

src/stories/InstallCommand.stories.tsx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -586,12 +586,7 @@ export const CustomStorageKey: Story = {
586586
export const WithScreenshotCapability: Story = {
587587
render: () => (
588588
<ComponentScreenshot>
589-
<InstallCommand
590-
packageName="react-install-command"
591-
isDev={true}
592-
version="^1.0.0"
593-
theme="dark"
594-
/>
589+
<InstallCommand packageName="react-install-command" />
595590
</ComponentScreenshot>
596591
),
597592
parameters: {

0 commit comments

Comments
 (0)