@rabbitio/ui-kit 1.0.0-beta.10 → 1.0.0-beta.12

package/README.md

@@ -1,30 +1,30 @@
 # Installation
-~~~
+~~~bash
 npm install --save @rabbitio/ui-kit
 ~~~
 
 # Using library
-1. To use components for web:
+1. To use components or base modules for web:
 * import the following way
-~~~
-import { Button } from "@rabbitio/ui-kit";
+~~~javascript
+import { Button, AmountUtils } from "@rabbitio/ui-kit";
 ~~~
 * add top-level styles import
-~~~
+~~~javascript
 import "@rabbitio/ui-kit/index.css";
 ~~~
-2. To use components for next.js import the following way and add "@rabbitio/ui-kit" to transpilePackages inside your next.config.js:
+2. To use components or base modules for next.js import the following way and add "@rabbitio/ui-kit" to transpilePackages inside your next.config.js:
 
-* Import the following way
-~~~
+~~~javascript
 import { Button } from "@rabbitio/ui-kit/next";
+import { AmountUtils } from "@rabbitio/ui-kit";
 ~~~
 * add "@rabbitio/ui-kit" to transpilePackages in next.config.js
-~~~
+~~~javascript
 transpilePackages: ["@rabbitio/ui-kit"],
 ~~~
 * Import styles inside pages/_app.js
-~~~
+~~~javascript
 import "@rabbitio/ui-kit/index.css";
 ~~~
 
@@ -32,22 +32,22 @@ import "@rabbitio/ui-kit/index.css";
 1. Add a directory for component under the semantically corresponding subdirectory inside **./stories**
 2. Under the component directory implement 3 files: **<Component>.js**, **<Component>.module.scss**, **<Component>.stories.js**
 3. Add the implemented component import to barrel file **./stories/index.js**
-~~~
+~~~javascript
 export { default as <Component> } from "./path/to/<Component>";
 ~~~
 
 # Running storybook
-~~~
+~~~bash
 sudo docker build -t storybook-app .
 ~~~
-~~~
+~~~bash
 sudo docker run -d -p 6006:6006 storybook-app
 ~~~
 
 # Publishing
 1. Increase version number and commit
 2. Run:
-~~~
+~~~bash
 npm login
 npm publish --access public
 ~~~