Skip to content

Commit 4c2e495

Browse files
committed
0.22.15 - update readme, attempt to fix publishing to npm
1 parent 1c9364a commit 4c2e495

3 files changed

Lines changed: 12 additions & 11 deletions

File tree

.github/workflows/build-test-and-publish.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,6 @@ jobs:
4141
run: cp .npmrc.github .npmrc
4242
- name: Print user for publishing to NPM
4343
run: echo "Attempting to publish package as user $NPM_PACKAGE_PUBLISH_USER"
44-
- name: Verify NPM_PACKAGE_PUBLISH_TOKEN is set
45-
run: |
46-
if [ -z "${{ secrets.NPM_PACKAGE_PUBLISH_TOKEN }}" ]; then
47-
echo "Error: NPM_PACKAGE_PUBLISH_TOKEN not set. Aborting..."
48-
exit 1
49-
fi
5044
- name: Publish package to NPMJS registry
5145
run: bun publish --registry=https://registry.npmjs.org
5246
env:

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# @schemavaults/theme
1+
# 🎨 @schemavaults/theme
22

3-
## About
3+
## About 🎨
44

5-
Package containing code for building TailwindCSS themes that contain SchemaVaults branding colors and shared styles.
5+
Package containing code for building opionated TailwindCSS themes/configurations that contain SchemaVaults branding colors and shared styles.
6+
7+
To see the theme in action you can check out the [`@schemavaults/ui` preview site](https://ui.schemavaults.com) showcasing some styled React.js components and the features available in this theme.
68

79
## Usage
810

@@ -11,13 +13,15 @@ Package containing code for building TailwindCSS themes that contain SchemaVault
1113
The generated TailwindCSS config sets colors based on CSS variables. It's important that `globals.css` is imported, so that these colors can be resolved. E.g. `var(--foreground)` and `var(--card)` become functional after this CSS import.
1214

1315
```javascript
16+
// within App.jsx / layout.jsx
1417
import "@schemavaults/theme/globals.css"
1518
```
1619

1720
### Import and run the TailwindCSS Config Factory from your `tailwind.config.mjs` or `tailwind.config.ts`
1821

1922
#### Simple Example
2023
```typescript
24+
// tailwind.config.ts
2125
import { SchemaVaultsTailwindConfigFactory } from "@schemavaults/theme";
2226
const config = new SchemaVaultsTailwindConfigFactory().createConfig({
2327
content: [
@@ -30,6 +34,8 @@ export default config;
3034

3135
#### More complex example
3236
```typescript
37+
// tailwind.config.ts
38+
3339
// Import the config factory
3440
import { SchemaVaultsTailwindConfigFactory } from "@schemavaults/theme";
3541
import { join } from "path";
@@ -88,7 +94,8 @@ export default config;
8894

8995
You may wish to also dig deeper on the options passed to the factory / `createConfig` in order to customize the final Tailwind configuration generated. Notably, the `content` parameter to `createConfig`, if the code for styles to be generated from is not found within `./src/**/*.ts|tsx|js|jsx`!
9096

91-
```javascript
97+
```typescript
98+
// tailwind.config.ts
9299
// ... initialize the factory somewhere
93100

94101
// An example demonstrating customization of where Tailwind searches for classnames

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@schemavaults/theme",
33
"description": "TailwindCSS theme shared by different SchemaVaults applications",
4-
"version": "0.22.14",
4+
"version": "0.22.15",
55
"private": false,
66
"license": "UNLICENSED",
77
"repository": {

0 commit comments

Comments
 (0)