@rabbitio/ui-kit 1.0.0-alpha.9 → 1.0.0-beta.10

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 CHANGED
@@ -4,13 +4,28 @@ npm install --save @rabbitio/ui-kit
4
4
  ~~~
5
5
 
6
6
  # Using library
7
- 1. To use components just import them
7
+ 1. To use components for web:
8
+ * import the following way
8
9
  ~~~
9
10
  import { Button } from "@rabbitio/ui-kit";
10
11
  ~~~
11
- 2. [In progress] Also, you can import base styles into your scss index file:
12
+ * add top-level styles import
12
13
  ~~~
13
- @import "@rabbitio/ui-kit/styles/index";
14
+ import "@rabbitio/ui-kit/index.css";
15
+ ~~~
16
+ 2. To use components for next.js import the following way and add "@rabbitio/ui-kit" to transpilePackages inside your next.config.js:
17
+
18
+ * Import the following way
19
+ ~~~
20
+ import { Button } from "@rabbitio/ui-kit/next";
21
+ ~~~
22
+ * add "@rabbitio/ui-kit" to transpilePackages in next.config.js
23
+ ~~~
24
+ transpilePackages: ["@rabbitio/ui-kit"],
25
+ ~~~
26
+ * Import styles inside pages/_app.js
27
+ ~~~
28
+ import "@rabbitio/ui-kit/index.css";
14
29
  ~~~
15
30
 
16
31
  # Adding new component