Update README.md

README.md

@@ -0,0 +1,54 @@
+<div align="center">
+
+![zway.app logo.](https://nextjs-shadcn-template.vercel.app/favicon.ico)
+
+<h1 align="center" id="title">Nextjs &amp; shadcn Template</h1>
+<p>
+    Template is designed to provide you with a solid foundation for your web development projects. With Next.js powering your React applications and Shadcn offering sleek UI components you can jumpstart your projects with ease.
+</p>
+</div>
+
+<div align="center">
+<img width="700" height="500" src="https://nextjs-shadcn-template.vercel.app/og.png" alt="Nextjs &amp; shadcn Template features." />
+
+</div>
+
+### 🛠️ **Stack**
+
+- Next.js 14.
+- Tailwind CSS.
+- **Components**: [shadcn/ui](https://ui.shadcn.com)
+
+### ✨ **Features**
+
+- Prettier & Eslint.
+- Github Actions.
+- Husky.
+- [Bun](https://bun.sh)
+
+### ⛔ **Possible Errors**
+<details>
+  <summary><b>Github Actions</b></summary>
+
+  - If you push a commit and it shows "... ❌", here is the fix
+
+  - #### 1. Settings
+    ![first](https://github.com/JJozef/nextjs-shadcn-template/assets/101532359/771a3084-284d-4f65-b55d-36601e4ee1f8)
+
+  - #### 2. Actions - General
+    ![second](https://github.com/JJozef/nextjs-shadcn-template/assets/101532359/4e54b826-7a86-4523-a48c-a3ec921594e7)
+
+  - #### 3. Workflow Permissions
+    ![three](https://github.com/JJozef/nextjs-shadcn-template/assets/101532359/3904d21d-4852-4cf2-bf63-06c4c58f022e)
+
+</details>
+
+### 🚀 **Contribute**
+
+1. Fork the repository.
+2. Clone the repository.
+3. Install [Bun](https://bun.sh) if you haven't already.
+4. Run `bun i` to install the dependencies.
+5. Run `bun dev` to start the development server.
+6. Open `http://localhost:3000` to view it in the browser.
+7. Make your changes and open a pull request.