@maxio-com/self-service 1.7.2 → 1.7.3

package/README.md

@@ -2,7 +2,42 @@
 
 [![written in typescript](https://img.shields.io/badge/written%20in-typescript-blue.svg)](https://www.typescriptlang.org) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-yellow.svg)](https://github.com/prettier/prettier) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://facebook.github.io/jest/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![yarn](https://img.shields.io/badge/maintained%20with-yarn-cc00ff.svg)](https://yarnpkg.com/en/) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-green.svg)](https://lerna.js.org/)
 
-## 🔧 Installation
+## 🔧 Installation and usage
+
+### 1. Install dependencies
+
+```sh
+pnpm install @maxio-com/self-service
+npm install @maxio-com/self-service
+yarn add @maxio-com/self-service
+```
+
+### 2. Import components
+Import components from `@maxio-com/self-service` package as ES6 modules or include them in your HTML file.
+
+```js
+import MaxioSelfService from '@maxio-com/self-service';
+```
+### 3. Use components
+
+```js
+const componentsFactory = new window.Maxio.Components({
+    theme: componentsTheme,
+    i18nSettings: {
+        loadPath: 'loadPath-url',
+        language: locale,
+    },
+    accessTokenUrl:
+        'accessTokenUrl-url',
+});
+```
+
+### 4. Examples
+
+#### Vue.js example is available in [vue-self-service-example](https://github.com/maxio-com/vue-self-service-example) directory.
+#### React.js example is available in [react-self-service-example](https://github.com/maxio-com/react-self-service) directory.
+
+##  Installation
 
 Please follow the steps described below to correctly setup mono-repository.