sigma-ui 1.0.10 → 1.0.11
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 +45 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
<h1>
|
|
2
|
+
<img valign="middle" src=".npm/sigma-ui-logo-color.png" width="64px">
|
|
3
|
+
SIGMA-UI
|
|
4
|
+
</h1>
|
|
5
|
+
|
|
6
|
+
**SIGMA-UI** - is a collection of fully customizable well-built components and blocks for Vue, using recently invented distribution method via `npx` that I call GOAT (Git Obtained As Template).
|
|
7
|
+
|
|
8
|
+
It takes away the burden of recreating the same components from scratch for every new project, giving you components that you can quickly add and modify to your design system.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## About
|
|
13
|
+
|
|
14
|
+
**Website**: https://sigma-ui.dev
|
|
15
|
+
<br/>**NPM**: https://www.npmjs.com/package/sigma-ui
|
|
16
|
+
|
|
17
|
+
- **Supported frameworks**: Vue, Nuxt, Laravel, Astro.
|
|
18
|
+
- **Supported languages**: TS (all components are typed, JS is not supported, move on).
|
|
19
|
+
- **Supported vue versions**: 3 and above.
|
|
20
|
+
- **Supported style systems**: CSS, Tailwind 4.
|
|
21
|
+
- **Is open-source**: Yes, MIT licensed.
|
|
22
|
+
- **Accessibility**: Supported.
|
|
23
|
+
- **Based upon**: Radix Vue primitives.
|
|
24
|
+
- **Installation method**: GOAT (Git Obtained As Template) via npx commands. Unlike NPM modules, these components are copied from git repository directly into your project's components directory and give you full control over customization, instead of using just props and css overrides.
|
|
25
|
+
- **Main problem it solves**: You are a developer, you create a new project, it needs 20+ components like dialogs, selects, skeletons, etc, and they all need to follow your companies' / your own design system.
|
|
26
|
+
- **Beta devs** - spend half a year creating every component from scratch for every new project they work in and end up with a broken buggy mess, or use Vuetify / Quasar like library and monkey patch components' css with `!important`, trying to make them look like components in their design system.
|
|
27
|
+
- **Sigma devs** - have GOAT in their stack, use well designed customizable components, easily modify design and functionality to their needs. Profit.
|
|
28
|
+
|
|
29
|
+
## Community links
|
|
30
|
+
[Discord](https://discord.gg/jH2X4VGBA4) | [YouTube](https://www.youtube.com/@sigma-dev) | [X (Twitter)](https://twitter.com/sigma__dev) | [Telegram](https://t.me/sigma_devs)
|
|
31
|
+
<br>Thanks to everyone who has been sharing this project with others!
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## Credits
|
|
35
|
+
|
|
36
|
+
Created, designed, and maintained by [Aleksey Hoffman](https://github.com/aleksey-hoffman).
|
|
37
|
+
|
|
38
|
+
Special thanks to all the open-source projects and developers who have inspired and contributed to the foundation that led to the creation of this project:
|
|
39
|
+
|
|
40
|
+
- [Shadcn](https://github.com/shadcn): open-source developer that showcased the first implmentation of the GOAT distribution method and beautiful components for it.
|
|
41
|
+
- [Zernonia](https://github.com/zernonia): open-source developer that created Reka-ui primitives which are used as the basis for this project.
|
|
42
|
+
|
|
43
|
+
## License
|
|
44
|
+
|
|
45
|
+
Licensed under the [MIT license](https://github.com/sigma-hub/sigma-ui/blob/main/LICENSE).
|