docs: updated README (Shopify#20)

## Context Updated the `README.md` in all packages with the correct information for the `.npmrc` ## Changes Added the new config into the `README.md` ## Checklist - [x] My code follows the style guidelines of this project - [x] I've performed a self-review of my own code - [x] I've added a changeset if this PR contains user-facing or noteworthy changes - [x] I've commented my code, particularly in hard-to-understand areas - [x] I've made corresponding changes to the documentation - [x] I've tested my code for breaking changes and added the corresponding footer in this PR if needed
remcolakens · Jun 7, 2023 · eb993b1 · eb993b1
1 parent e6c4f96
commit eb993b1
Show file tree

Hide file tree

Showing 11 changed files with 121 additions and 29 deletions.
diff --git a/.changeset/empty-pumpkins-lay.md b/.changeset/empty-pumpkins-lay.md
@@ -0,0 +1,12 @@
+---
+'@code-internet-applications/eslint-config-code': patch
+'@code-internet-applications/tailwind-utils': patch
+'@code-internet-applications/prettier-config': patch
+'@code-internet-applications/tailwind-config': patch
+'@code-internet-applications/postcss-config': patch
+'@code-internet-applications/accordion': patch
+'@code-internet-applications/react': patch
+'@code-internet-applications/tsconfig': patch
+---
+
+updated the README docs with the correct .npmrc information
diff --git a/.npmrc b/.npmrc
@@ -1,4 +1,8 @@
 @shopify:registry=https://registry.npmjs.com
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
 auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
 node-linker=hoisted
diff --git a/packages/components/accordion/README.md b/packages/components/accordion/README.md
@@ -13,11 +13,11 @@ pnpm add @code-internet-applications/accordion
 
 ```
 import {
-  Accordion,
-  AccordionItem,
-  AccordionButton,
-  AccordionPanel,
-} from "@code-internet-applications/accordion"
+	Accordion,
+	AccordionContent,
+	AccordionItem,
+	AccordionTrigger,
+} from '@code-internet-applications/accordion';
 ```
 
 ## Component
@@ -31,20 +31,26 @@ import {
 ## Usage
 
 ```
-<Accordion>
-  <AccordionItem>
-    <h2>
-      <AccordionButton>Section 1 title</AccordionButton>
-    </h2>
-    <AccordionPanel>Panel 1</AccordionPanel>
-  </AccordionItem>
-
-  <AccordionItem>
-    <h2>
-      <AccordionButton>Section 2 title</AccordionButton>
-    </h2>
-    <AccordionPanel>Panel 2</AccordionPanel>
-  </AccordionItem>
+<Accordion type="single" collapsible className="w-full">
+	<AccordionItem value="item-1">
+		<AccordionTrigger>Is it accessible?</AccordionTrigger>
+		<AccordionContent>
+			Yes. It adheres to the WAI-ARIA design pattern.
+		</AccordionContent>
+	</AccordionItem>
+	<AccordionItem value="item-2">
+		<AccordionTrigger>Is it styled?</AccordionTrigger>
+		<AccordionContent>
+			Yes. It comes with default styles that matches the other components
+			aesthetic.
+		</AccordionContent>
+	</AccordionItem>
+	<AccordionItem value="item-3">
+		<AccordionTrigger>Is it animated?</AccordionTrigger>
+		<AccordionContent>
+			Yes. Its animated by default, but you can disable it if you prefer.
+		</AccordionContent>
+	</AccordionItem>
 </Accordion>
 ```
 
@@ -62,4 +68,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/components/react/README.md b/packages/components/react/README.md
@@ -31,4 +31,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/config/eslint-config-code/README.md b/packages/config/eslint-config-code/README.md
@@ -32,4 +32,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/config/postcss-config/README.md b/packages/config/postcss-config/README.md
@@ -32,4 +32,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/config/prettier-config/README.md b/packages/config/prettier-config/README.md
@@ -31,4 +31,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/config/tailwind-config/README.md b/packages/config/tailwind-config/README.md
@@ -15,10 +15,14 @@ file as follows:
 
 ```
 import type { Config } from 'tailwindcss';
-import { tailwindConfig } from '../../packages/config/tailwind-config/tailwind.config';
+import { tailwindConfig } from '@code-internet-applications/tailwind-config';
 
 export default {
 	presets: [tailwindConfig],
+	  content: [
+    './app/**/*.{js,jsx,ts,tsx}',
+    './node_modules/@code-internet-applications/**/**/*.js',
+  ],
 } satisfies Config;
 
 ```
@@ -37,4 +41,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/config/tsconfig/README.md b/packages/config/tsconfig/README.md
@@ -33,4 +33,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/packages/utilities/tailwind-utils/README.md b/packages/utilities/tailwind-utils/README.md
@@ -23,4 +23,10 @@ of your project:
 
 ```
 @code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
 ```
diff --git a/plop/component/README.md.hbs b/plop/component/README.md.hbs
@@ -2,12 +2,30 @@
 
 {{description}}
 
-## Installation ``` pnpm add @code-internet-applications/{{dashCase
-	componentName
-}}
-``` ## Contribution See the [contributing
-guidelines](https://github.com/code-internet-applications/cbt-hydrogen/blob/main/CONTRIBUTING.md)
-for more details. ## Troubleshooting To ensure that you can access the packages
-from the GitHub package registry, make sure to add the following line to your
-`.npmrc` file in the root directory of your project: ```
-@code-internet-applications:registry=https://npm.pkg.github.com ```
+## Installation
+
+```
+pnpm add @code-internet-applications/{{dashCase componentName}}
+```
+
+## Contribution
+
+See the
+[contributing guidelines](https://github.com/code-internet-applications/cbt-hydrogen/blob/main/CONTRIBUTING.md)
+for more details.
+
+## Troubleshooting
+
+To ensure that you can access the packages from the GitHub package registry,
+make sure to add the following line to your `.npmrc` file in the root directory
+of your project:
+
+```
+@code-internet-applications:registry=https://npm.pkg.github.com
+public-hoist-pattern[]=@code-internet-applications/*
+
+auto-install-peers=true
+strict-peer-dependencies=false
+enable-pre-post-scripts=true
+node-linker=hoisted
+```