@telia/teddy 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,12 @@
 # Teddy - Telia Norway's Design System
 
-![Teddy - Telia Norway's Design System](/other/stories/assets/teddy200.png?raw=true)
+<p align="center">
+  <img src="https://d67ed36g77c51.cloudfront.net/teddy200.png" width="100" alt="Teddy - Telia Norway's Design System" />
+</p>
+<p align="center">
+  <img src="https://img.shields.io/npm/v/@telia/teddy?style=flat-square&color=00a8f0" alt="npm version" />
+  <img src="https://img.shields.io/npm/dm/@telia/teddy?style=flat-square&color=00a8f0" alt="downloads" />
+</p>
 
 Welcome to Teddy, Telia Norway's advanced component library crafted to enhance the development of consistent,
 user-friendly interfaces. Teddy offers a suite of components styled in harmony with Telia's brand guidelines, aiming to
@@ -31,8 +37,8 @@ To contribute to or utilize Teddy:
 
 2. **Setup**
 
-   - Node.js (v20)
-   - PNPM (v8)
+   - Node.js (v20) `nvm install 20 --lts`/`nvm use 20`
+   - PNPM (v8) `npm install -g pnpm@8`
 
 3. **Install dependencies**:
 
@@ -58,19 +64,17 @@ The `lib` directory is where the core parts of the Teddy library are located. It
 
 #### Other Folder
 
-The `other` directory supports the development and documentation of Teddy with: Incorporating the functionality of the
-`plopfile.ts` script into the `README.md` under the **Scripts** section, you can describe it as follows:
+The `other` directory supports the development and documentation of Teddy.
 
 - **Scripts**: Contains automation scripts crucial for the development and maintenance of the project. These scripts
   include:
   - **Icon and Token Generation**: Scripts for generating icons and tokens that populate the `lib/icons` and
     `lib/tokens` directories, ensuring design consistency and scalability across the project.
   - **Component Scaffolding with Plop**: Utilizes `plopfile.ts` to automate the process of creating new components,
-    whether they are core components, team-specific components, or derived from the Purpur project. This setup
-    streamlines the addition of new components to the project by providing a series of prompts to specify the
-    component's attributes (such as name, category, and team) and then automatically generating the necessary files
-    according to predefined templates. This process not only saves time but also enforces coding and design standards
-    across the project.
+    whether they are core components or team-specific components. This setup streamlines the addition of new components
+    to the project by providing a series of prompts to specify the component's attributes (such as name, category, and
+    team) and then automatically generating the necessary files according to predefined templates. This process not only
+    saves time but also enforces coding and design standards across the project.
 - **Stories**: Storybook stories that document the project.
 - **Tokens**: Source files for design tokens that dictate the library's foundational styles.
 - **SVG-Icons**: A collection of SVG files that are transformed into svg-sprite for the library. For more information,