basecoat-css 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# basecoat-css
|
|
2
|
+
|
|
3
|
+
This package provides the core CSS styles for [Basecoat](https://basecoatui.com), a component library built with Tailwind CSS.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
Your project must have [Tailwind CSS](https://tailwindcss.com/docs/installation) installed and configured, as Basecoat relies on Tailwind utility classes and theming.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
You can install `basecoat-css` using your preferred package manager:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# npm
|
|
15
|
+
npm install basecoat-css
|
|
16
|
+
|
|
17
|
+
# yarn
|
|
18
|
+
yarn add basecoat-css
|
|
19
|
+
|
|
20
|
+
# pnpm
|
|
21
|
+
pnpm add basecoat-css
|
|
22
|
+
|
|
23
|
+
# bun
|
|
24
|
+
bun add basecoat-css
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Alternatively, you can download the `basecoat.css` file directly from the [GitHub repository](https://github.com/hunvreus/basecoat/blob/main/src/css/basecoat.css) (or the `dist/basecoat.css` file from this package after installation) and include it in your project.
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
After installation, import `basecoat-css` into your main CSS file. Make sure to import it **after** Tailwind CSS and **before** any custom theme overrides.
|
|
32
|
+
|
|
33
|
+
```css
|
|
34
|
+
/* Your main CSS file (e.g., styles.css) */
|
|
35
|
+
|
|
36
|
+
@import "tailwindcss/base";
|
|
37
|
+
@import "tailwindcss/components";
|
|
38
|
+
@import "tailwindcss/utilities";
|
|
39
|
+
|
|
40
|
+
@import "basecoat-css"; /* Or the path to basecoat.css if manually added */
|
|
41
|
+
|
|
42
|
+
/* Your custom styles or theme overrides (optional) */
|
|
43
|
+
/* @import "your-theme.css"; */
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Once imported, you can start using Basecoat's component classes in your HTML.
|
|
47
|
+
|
|
48
|
+
## Documentation
|
|
49
|
+
|
|
50
|
+
For more detailed information on components, their usage, and customization options, please refer to the [Basecoat documentation](https://basecoatui.com/installation/#install-css).
|
|
51
|
+
|
|
52
|
+
## License
|
|
53
|
+
|
|
54
|
+
[MIT](https://github.com/hunvreus/basecoat/blob/main/LICENSE.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "basecoat-css",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Tailwind CSS for Basecoat components",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "hunvreus",
|
|
@@ -37,4 +37,4 @@
|
|
|
37
37
|
"url": "https://github.com/hunvreus/basecoat/issues"
|
|
38
38
|
},
|
|
39
39
|
"homepage": "https://basecoatui.com/installation#install-css"
|
|
40
|
-
}
|
|
40
|
+
}
|