diff --git a/clayui.com/content/docs/get-started/how-to-use-clay.md b/clayui.com/content/docs/get-started/how-to-use-clay.md index b7f3fe8a55..1b480cf768 100644 --- a/clayui.com/content/docs/get-started/how-to-use-clay.md +++ b/clayui.com/content/docs/get-started/how-to-use-clay.md @@ -33,15 +33,24 @@ You can check out the full list of [packages available in NPM](https://www.npmjs #### NPM ```shell{expanded} -npm install @clayui/css @clayui/* +npm install @clayui/css @clayui/{PACKAGE_NAME} ``` #### Yarn ```shell{expanded} -yarn add @clayui/css @clayui/* +yarn add @clayui/css @clayui/{PACKAGE_NAME} ``` +> **_Important Note: Be Mindful of the Asterisk:_** +> When using the `@clayui/*` command for installation, it's crucial to remember that the asterisk (\*) is a placeholder. It's not a valid package name on its own. To install a specific Clay package, you must replace the asterisk with the name of the package you require. +> +> For instance, if you want to install the "Clay Button" package, the correct command would be: +> +> ```shell +> npm install @clayui/button or yarn add @clayui/button +> ``` + ### Install via Clay CSS CDN We provide Clay CSS via CDN, which is an option when you do not want to install the clay package via NPM or Yarn. @@ -74,6 +83,11 @@ Example: This quick start requires that you have a minimum knowledge of React Hooks, not much of your API's will be used but just useState to control the component. +
+ Warning + To ensure that Clay functions correctly, please remember to import the CSS package from @clayui/css into your React entrypoint component, as demonstrated in the example below. +
+ For this quick start we will use [codesandbox](https://codesandbox.io/) which does not need to install an environment on your machine. Use the **codesandbox** below as your text editor and environment so we can follow through with the examples. diff --git a/clayui.com/static/images/icons/icons.svg b/clayui.com/static/images/icons/icons.svg index 0faea8c5cb..9fa6afca81 100644 --- a/clayui.com/static/images/icons/icons.svg +++ b/clayui.com/static/images/icons/icons.svg @@ -103,16 +103,16 @@ - + - + - + - +