Skip to content

Commit bf6fa20

Browse files
committed
docs: reorganize readme and add npm package link
1 parent 60adbd7 commit bf6fa20

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,6 @@ Below is a list of the components available in this library. Each component has
2020
- [BBBToggle](./src/components/Toggle/README.md)
2121
- [BBBTypography](./src/components/Typography/README.md)
2222

23-
## Installation
24-
25-
This library is under active development and has not yet been published on npm. For now, you can clone the repository and install it locally.
26-
27-
### Building the bundle
28-
29-
```
30-
npm install
31-
npm run build
32-
```
33-
34-
### Using npm link
35-
36-
When developing and testing locally with `npm link`, you may need to adjust your Webpack configuration to ensure compatibility with `styled-components` and `react`, which do not handle multiple instances well. Add the following alias configuration to the project that uses this library:
37-
38-
```json
39-
resolve: {
40-
alias: {
41-
'styled-components': path.resolve('./node_modules/styled-components'),
42-
react: path.resolve('./node_modules/react'),
43-
'react-dom': path.resolve('./node_modules/react-dom'),
44-
},
45-
}
46-
```
47-
4823
## Peer Dependencies
4924

5025
This library requires the following peer dependencies to be installed in your project:
@@ -129,3 +104,36 @@ The following table lists the supported CSS variables for color overriding, extr
129104
```
130105

131106
If you need to override colors for specific components or add new variables, refer to the component's `styles.ts` file for implementation details.
107+
108+
## Installation
109+
110+
You can install the library directly from npm:
111+
112+
```bash
113+
npm install @mconf/bbb-ui-components-react
114+
```
115+
116+
## Local Development
117+
118+
If you want to build the library locally or contribute:
119+
120+
### Building the bundle
121+
122+
```
123+
npm install
124+
npm run build
125+
```
126+
127+
### Using npm link
128+
129+
When developing and testing locally with `npm link`, you may need to adjust your Webpack configuration to ensure compatibility with `styled-components` and `react`, which do not handle multiple instances well. Add the following alias configuration to the project that uses this library:
130+
131+
```json
132+
resolve: {
133+
alias: {
134+
'styled-components': path.resolve('./node_modules/styled-components'),
135+
react: path.resolve('./node_modules/react'),
136+
'react-dom': path.resolve('./node_modules/react-dom'),
137+
},
138+
}
139+
```

0 commit comments

Comments
 (0)