Skip to content

Commit e11598b

Browse files
committed
Merge branch 'main' of github.com:rotemhoresh/shadcn-templ
2 parents 895375e + ed018c7 commit e11598b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Shadcn/ui port for Go + Templ + Alpine.js + Tailwind CSS
22

3+
[![Go Reference](https://pkg.go.dev/badge/github.com/rotemhoresh/shadcn-templ.svg)](https://pkg.go.dev/github.com/rotemhoresh/shadcn-templ)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/rotemhoresh/shadcn-templ)](https://goreportcard.com/report/github.com/rotemhoresh/shadcn-templ)
6+
37
### Note
48

59
This is a work in proccess.
@@ -68,11 +72,13 @@ templ Comp(componentSpecificParams, classes string, attrs templ.Attributes)
6872

6973
Any **components specific parameters** at the begining, then **classes** and **attrs** for every component (see [example](#example) for the params of the `Button` component).
7074

75+
The components are written with constant referencing to the shadcn/ui source code and the underlying radix components.
76+
7177
## Contributing
7278

7379
Contributions are welcome for both new components and improvements for existing ones.
7480

75-
Make sure to read the README.md and go over the codebase to understand the design choices and overall coding style.
81+
Make sure to read the README and go over the codebase to understand the design choices and overall coding style as well as getting familiar with shadcn/ui.
7682

7783
### License
7884

0 commit comments

Comments
 (0)