8000 Add initial README.md with project overview and installation instructions to core package by codecalm · Pull Request #2392 · tabler/tabler · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 19, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
93fc952
feat: add initial README.md with project overview and installation in…
codecalm May 19, 2025
d055121
fix: update README file in core package
codecalm May 19, 2025
23aef4f
feat: add detailed README for Tabler Core with installation instructi…
codecalm May 19, 2025
c59a4df
Merge branch 'dev' of https://github.com/tabler/tabler into dev-fix-r…
codecalm May 19, 2025
b4954af
fix: remove symlink to README in core package
codecalm May 19, 2025
b74c494
feat: add comprehensive README for Tabler Core with installation and …
codecalm May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/readme-fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@tabler/core": patch
---

Fix README file in core package
16 changes: 0 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
1 change: 0 additions & 1 deletion core/README.md
View file
Open in desktop

This file was deleted.

42 changes: 42 additions & 0 deletions core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
0