Skip to content

Commit

Permalink
Fix typo in docs, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WarningImHack3r committed Sep 14, 2024
1 parent d7a944d commit c81c6c4
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 9 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,14 @@ otherwise.**
- Supports _all_ shadcn/ui implementations: Svelte, React, Vue, and Solid
- Browse available components
- Easily search for remote or existing components
- (Soon) support monorepos
- ...and more!

## Planned Features

- Support monorepos with multiple `components.json` files
- Allow initializing a shadcn/ui implementation within an existing project
- Add/improve support for the horizontal tool window layout

## Usage

Simply open the `shadcn/ui` tool window and start managing your components.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.config
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte locally installed components.json file.
* A shadcn locally installed components.json file.
*/
@Suppress("PROVIDED_RUNTIME_TOO_LOW", "kotlin:S117", "unused", "PropertyName")
@Serializable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.config
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte locally installed components.json file.
* A shadcn locally installed components.json file.
* @param `$schema` The schema URL for the file.
* @param style The library's style used.
* @param rsc Whether to support React Server Components.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.config
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte locally installed components.json file.
* A shadcn locally installed components.json file.
* @param `$schema` The schema URL for the file.
* @param tailwind The Tailwind configuration.
* @param uno The UnoCSS configuration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.config
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte locally installed components.json file.
* A shadcn locally installed components.json file.
* @param `$schema` The schema URL for the file.
* @param tsx Whether to use TypeScript over JavaScript.
* @param componentDir The components' directory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.config
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte locally installed components.json file.
* A shadcn locally installed components.json file.
* @param `$schema` The schema URL for the file.
* @param style The library's style used.
* @param tailwind The Tailwind configuration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte locally installed components.json file.
* A shadcn locally installed components.json file.
* @param `$schema` The schema URL for the file.
* @param style The library style installed.
* @param typescript Whether to use TypeScript over JavaScript.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.remote
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte component in the registry.
* A shadcn component in the registry.
* @param name The name of the component.
* @param dependencies The npm dependencies of the component.
* @param registryDependencies The other components that this component depends on.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package com.github.warningimhack3r.intellijshadcnplugin.backend.sources.remote
import kotlinx.serialization.Serializable

/**
* A shadcn-svelte component in the registry.
* A shadcn component in the registry.
* @param name The name of the component.
* @param dependencies The npm dependencies of the component.
* @param registryDependencies The other components that this component depends on.
Expand Down

0 comments on commit c81c6c4

Please sign in to comment.