Skip to content

Commit 7299368

Browse files
committed
prepare for upload
1 parent beded14 commit 7299368

File tree

11 files changed

+579
-2166
lines changed

11 files changed

+579
-2166
lines changed

.github/workflows/ci.yml

+1-21
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,4 @@ jobs:
2323
cache: 'npm'
2424
- run: npm ci
2525
- run: npm test
26-
- run: npm run build
27-
28-
docs:
29-
needs: test
30-
runs-on: ubuntu-latest
31-
if: github.ref == 'refs/heads/main'
32-
33-
steps:
34-
- uses: actions/checkout@v3
35-
- name: Use Node.js
36-
uses: actions/setup-node@v3
37-
with:
38-
node-version: '18.x'
39-
cache: 'npm'
40-
- run: npm ci
41-
- run: npm run docs:build
42-
- name: Deploy to GitHub Pages
43-
uses: peaceiris/actions-gh-pages@v3
44-
with:
45-
github_token: ${{ secrets.GITHUB_TOKEN }}
46-
publish_dir: docs/.vitepress/dist
26+
- run: npm run build

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Tailwind Rounded Out
22

3-
A Tailwind CSS plugin that adds "outside" rounded corners to elements - similar to folder tabs or protruding cards. The plugin maintains background color/image inheritance while providing a wide range of customization options.
3+
A Tailwind CSS plugin that adds _**"outside" rounded corners**_ to elements
44

5-
[Demo Site - Coming Soon]
5+
<small>Similar to folder tabs or protruding cards. The plugin maintains background color/image inheritance while providing a wide range of customization options.</small>
66

77
<div align="center">
8-
<!-- Consider adding a screenshot or GIF here showing key examples -->
8+
<img src="docs/images/readme-example.png" alt="Demo of the plugin">
99
</div>
1010

1111
## Features
@@ -41,6 +41,7 @@ module.exports = {
4141
plugins: [require("tailwind-rounded-out")],
4242
};
4343
```
44+
<small>note: if you don't supply custom sizes, the plugin will use the same values from either the `theme.borderRadius` or the default theme sizes</small> <
4445

4546
## Basic Usage
4647

@@ -147,3 +148,12 @@ This plugin uses CSS `::before` and `::after` pseudo-elements to create the roun
147148
## License
148149

149150
MIT License - See [LICENSE](LICENSE) file for details
151+
152+
153+
## More Examples
154+
155+
#### Backgrounds are able to show through, no fake backgrounds.
156+
<img src="docs/images/readme-example2.png" alt="Demo of the plugin">
157+
158+
#### A range of corner variations
159+
<img src="docs/images/readme-example3.png" alt="Demo of the plugin">

docs/.vitepress/config.ts

-35
This file was deleted.

docs/guide/index.md

-42
This file was deleted.

docs/images/readme-example.png

77.2 KB
Loading

docs/images/readme-example2.png

109 KB
Loading

docs/images/readme-example3.png

42.4 KB
Loading

0 commit comments

Comments
 (0)