New readme (#50)

README.md

@@ -1,23 +1,62 @@
-# **Smashing.Tools**
+
+  <a href="https://github.com/smashing-team/smashing.tools">
+   <img src="https://raw.githubusercontent.com/smashing-team/.github/main/profile/organization-promo.png" alt="Logo">
+  </a>
+  <p align="center">
+    <a href="https://smashing.team">Website</a>
+    ·
+    <a href="https://github.com/smashing-team/smashing.tools/issues">Issues</a>
+    ·
+    <a href="https://github.com/orgs/smashing-team/discussions">Discussions</a>
+  </p>
+
+
+## **About**
 
 Smashing.Tools is an open-source platform designed for individuals to share their developed products and UI libraries. The project allows contributors to open pull requests by adding new markdown files while sharing their creations.
 
 ## **Technologies**
 
 - **Astro:** A tool used for building modern web applications through static site generation.
-- **Tailwind CSS:** A utility-first CSS framework used to create customizable UI components quickly.
+- **TailwindCSS:** A utility-first CSS framework used to create customizable UI components quickly.
 - **React:** A popular JavaScript library for building user interfaces.
 - **Pagefind:** A simple and fast search engine for static websites.
+- **KeyStatic:** A simple static site generator ideal for lightweight and fast-loading web pages.
+- **Netlify:** A cloud hosting service that automates deployment for web projects.
+
+## **Folder Structure**
+
+```
+smashing.tools/
+  ├── src/
+    │   ├── components/ # Mix of React and Astro components for UI versatility.
+    │   ├── content/ # Static content in Markdown for Astro-powered site.
+    │   ├── layouts/ # Layout templates defining UI structure.
+    │   ├── lib/ # Integration and management of external libraries.
+    │   ├── pages/ # Astro hybrid pages with static and dynamic content.
+    │   ├── plugins/ # Astro plugins for added functionality.
+    │   ├── styles/ # TailwindCSS styling for visual theme and design.
+    │   ├── types/ # TypeScript definitions for type safety and consistency.
+    │   ├── utils/ # Utility functions and helpers for common functionality.
+```
 
 ### **Getting Started**
 
 - Clone the repository: `git clone [email protected]:smashing-team/smashing.tools.git 'smashing-tools'`
 - Navigate to the project directory: `cd smashing-tools`
-- Install the required packages using Bun: `bun install`
-- Start the project: `bun run dev`
+- Install the required packages using Pnpm: `pnpm install`
+- Start the project: `pnpm dev`
 
 ### **Contributing**
 
 Thank you for considering contributing to Smashing.Tools! Before submitting your contributions, please review our [guidelines here](https://github.com/smashing-team/smashing.tools/blob/main/README.md). This guide contains detailed information on how you can contribute, code formatting, and more.
 
 You can find more information by following the link and easily submit your contributions.
+
+## Contributors
+
+Thank you for your contributions! We appreciate all the contributions from the community.
+
+<a href="https://github.com/smashing-team/smashing.tools/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=smashing-team/smashing.tools" />
+</a>