@nous-research/ui 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 +4 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,23 +1,17 @@
|
|
|
1
|
-
# nous
|
|
1
|
+
# nous ui
|
|
2
2
|
|
|
3
3
|
the shared design system for react ui @ nous. components, hooks, utils, fonts, overlays, etc.
|
|
4
4
|
|
|
5
5
|
## setup
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
if you're using next.js, add to your config:
|
|
10
|
-
|
|
11
|
-
```ts
|
|
12
|
-
transpilePackages: ['@nous/design-language']
|
|
13
|
-
```
|
|
7
|
+
`npm i @nous-research/ui` or `pnpm i @nous-research/ui`
|
|
14
8
|
|
|
15
9
|
import tailwind and the design language styles in your global css:
|
|
16
10
|
|
|
17
11
|
```css
|
|
18
12
|
@import 'tailwindcss';
|
|
19
13
|
@import 'tw-animate-css';
|
|
20
|
-
@import '@nous
|
|
14
|
+
@import '@nous-research/ui/styles/globals.css';
|
|
21
15
|
```
|
|
22
16
|
|
|
23
17
|
## usage
|
|
@@ -29,16 +23,8 @@ import {
|
|
|
29
23
|
Button,
|
|
30
24
|
Grid
|
|
31
25
|
// whatever else!
|
|
32
|
-
} from '@nous/
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## buiold
|
|
36
|
-
|
|
26
|
+
} from '@nous-research/ui'
|
|
37
27
|
```
|
|
38
|
-
pnpm build
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
compiles typescript, resolves path aliases, copies fonts + assets + css to `dist/`.
|
|
42
28
|
|
|
43
29
|
## demo app
|
|
44
30
|
|