@bigbinary/neetoui 3.2.52 → 3.2.53
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 +5 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@bigbinary/neetoui) [](https://standardjs.com)
|
|
4
4
|
|
|
5
|
-
**
|
|
5
|
+
**neetoUI** is the library that drives the experience in all [neeto products](https://neeto.com/) built at [BigBinary](https://www.bigbinary.com).
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
@@ -17,13 +17,13 @@ Starting `3.0.x`, neetoUI stylesheet has been separated from the bundle. To get
|
|
|
17
17
|
@import "@bigbinary/neetoui";
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
**
|
|
20
|
+
**neetoUI** has few peer dependencies which are required to use neetoUI properly. Install the peer dependencies using the below command:
|
|
21
21
|
|
|
22
22
|
```
|
|
23
23
|
yarn add react-toastify@8.0.2 formik@2.2.0 react-router-dom@5.2.0 react-router-nav-prompt@0.4.1
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
**
|
|
26
|
+
**neetoUI** depends on `react-toastify` for Toasters, so the styles for toaster must be imported to your main `scss` entry point.
|
|
27
27
|
|
|
28
28
|
```scss
|
|
29
29
|
@import "react-toastify/dist/ReactToastify.min.css";
|
|
@@ -56,11 +56,11 @@ yarn
|
|
|
56
56
|
|
|
57
57
|
You can create new components in the `lib/components` and export them from `lib/index.js`.
|
|
58
58
|
|
|
59
|
-
Running the `yarn storybook` command starts a storybook app. Use this application to test out changes. Note that nothing in the `stories` folder will be bundled with
|
|
59
|
+
Running the `yarn storybook` command starts a storybook app. Use this application to test out changes. Note that nothing in the `stories` folder will be bundled with neetoUI.
|
|
60
60
|
|
|
61
61
|
## Building
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
neetoUI gets auto-published to npm on new commit to master. You can checkout the `publish` workflow in git actions to get a live update.
|
|
64
64
|
|
|
65
65
|
## Documentation
|
|
66
66
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bigbinary/neetoui",
|
|
3
|
-
"version": "3.2.
|
|
3
|
+
"version": "3.2.53",
|
|
4
4
|
"main": "./index.js",
|
|
5
5
|
"author": "BigBinary",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"description": "
|
|
7
|
+
"description": "neetoUI is the library that drives the experience in all neeto products built at BigBinary",
|
|
8
8
|
"scripts": {
|
|
9
9
|
"start": "NODE_ENV=development webpack-dev-server --open --mode development --config webpack.dev.config.js",
|
|
10
10
|
"build": "NODE_ENV=production webpack --mode production --config webpack.config.js",
|