ab-ui-library 1.0.1 → 1.0.2
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 +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# AB UI Tools
|
|
2
2
|
|
|
3
|
-
See [UI library](https://
|
|
3
|
+
See [UI library]([https://github.com/uilibrarydev/uilibrary]) for live demos and comprehensive docs.
|
|
4
4
|
|
|
5
5
|
# Installation and usage
|
|
6
6
|
```
|
|
7
|
-
npm install
|
|
7
|
+
npm install ab-ui-library
|
|
8
8
|
```
|
|
9
9
|
|
|
10
10
|
Then use it in your app:
|
|
11
11
|
```jsx
|
|
12
12
|
import React from 'react';
|
|
13
|
-
import { Button } from '
|
|
14
|
-
import '
|
|
13
|
+
import { Button } from 'ab-ui-library/components/Button';
|
|
14
|
+
import 'ab-ui-library/assets/styles/styles.scss';
|
|
15
15
|
// Or you can import the styles.css file
|
|
16
|
-
// import '
|
|
16
|
+
// import 'ab-ui-library/assets/styles/styles.css';
|
|
17
17
|
|
|
18
18
|
const App = () => {
|
|
19
19
|
return <Button>Click me</Button>;
|
|
@@ -22,7 +22,7 @@ const App = () => {
|
|
|
22
22
|
|
|
23
23
|
How to use mixins:
|
|
24
24
|
```scss
|
|
25
|
-
@use "
|
|
25
|
+
@use "ab-ui-library/assets/styles/helpers/mixin";
|
|
26
26
|
|
|
27
27
|
.divider {
|
|
28
28
|
@include mixin.flexbox();
|
|
@@ -73,4 +73,4 @@ To trigger a release:
|
|
|
73
73
|
1. Commit your changes using the conventional commit format.
|
|
74
74
|
2. Open a pull request and merge it into the `master` branch with the appropriate commit message.
|
|
75
75
|
|
|
76
|
-
Semantic Release will handle the rest, including publishing to npm and creating a GitHub release.
|
|
76
|
+
Semantic Release will handle the rest, including publishing to npm and creating a GitHub release.
|