Prechádzať zdrojové kódy

Add initial README.md with project overview and installation instructions to core package (#2392)

Paweł Kuna 3 mesiacov pred
rodič
commit
446c34eceb
4 zmenil súbory, kde vykonal 47 pridanie a 17 odobranie
  1. 5 0
      .changeset/readme-fix.md
  2. 0 16
      README.md
  3. 0 1
      core/README.md
  4. 42 0
      core/README.md

+ 5 - 0
.changeset/readme-fix.md

@@ -0,0 +1,5 @@
+---
+"@tabler/core": patch
+---
+
+Fix README file in core package

+ 0 - 16
README.md

@@ -23,24 +23,8 @@ A premium and open source dashboard template with a responsive and high-quality
 	</a>
 </p>
 
-<p align="center">
-	<a href="https://github.com/sponsors/codecalm" target="_blank">
-			<img src="https://raw.githubusercontent.com/tabler/tabler/dev/shared/static/sponsor-banner-homepage.svg" alt="Sponsor Banner">
-	</a>
-</p>
-
 ## Testing
 
-<p align="center">Visual testing with:</p>
-
-<p align="center">
-	<a href="https://argos-ci.com/" target="_blank">
-		<picture>
-			<img src="https://github.com/user-attachments/assets/7d231a26-eff5-4fc5-8392-b2a679a7c572" alt="Argos-CI" height="164" />
-		</picture>
-	</a>
-</p>
-
 <p align="center">Browser testing via:</p>
 
 <p align="center">

+ 0 - 1
core/README.md

@@ -1 +0,0 @@
-../README.md

+ 42 - 0
core/README.md

@@ -0,0 +1,42 @@
+# Tabler Core
+
+Tabler Core is a set of components and utilities for building web applications. It provides a collection of pre-designed components, such as buttons, forms, modals, and more, that can be easily customized and integrated into your projects.
+
+## 🔎 Preview
+
+Tabler is fully responsive and compatible with all modern browsers. Thanks to its modern and user-friendly design you can create a fully functional interface that users will love! Choose the layouts and components you need and customize them to make your design consistent and eye-catching. Every component has been created with attention to detail to make your interface beautiful!
+
+<p align="center">
+	<a href="https://preview.tabler.io" target="_blank">
+			<img src="https://raw.githubusercontent.com/tabler/tabler/dev/shared/static/tabler-preview.png" alt="Tabler Preview">
+	</a>
+</p>
+
+## Installation
+
+To install Tabler Core, you can use npm or yarn. Run one of the following commands in your terminal:
+
+```bash
+npm install @tabler/core
+```
+
+or
+
+```bash
+pnpm add @tabler/core
+```
+
+## Sponsors
+
+**If you want to support our project and help us grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
+
+<p align="center">
+	<a href="https://github.com/sponsors/codecalm">
+		<img src="https://cdn.jsdelivr.net/gh/tabler/sponsors@latest/sponsors.svg" alt="Tabler sponsors">
+	</a>
+</p>
+
+
+## License
+
+See the [LICENSE](https://github.com/tabler/tabler/blob/master/LICENSE) file.