@divkitframework/divkit 3.0.0 → 4.0.0-patched-b90e1be4804b31ad27014160a0600d42cf9887d6

package/README.md

@@ -1,9 +1,11 @@
 ## DivKit for the Web
 
+![client code size](https://img.shields.io/badge/client%20lib%20minified&brotli-47.7%20KB-brightgreen)
+
 ### Installation
 
 ```
-npm i @divkit/divkit --save
+npm i @divkitframework/divkit --save
 ```
 
 ### Usage
@@ -21,7 +23,7 @@ JS code can be bundled with various strategies. Basically you need to answer a f
 On the server side there is `/server` module:
 
 ```js
-import {render} from '@divkit/divkit/server';
+import {render} from '@divkitframework/divkit/server';
 
 const html = render({
     id: 'smth',
@@ -38,7 +40,7 @@ const html = render({
 Then use `/client-hydratable` on client to hydrate server-side html::
 
 ```js
-import {render} from '@divkit/divkit/client-hydratable';
+import {render} from '@divkitframework/divkit/client-hydratable';
 
 render({
     id: 'smth',
@@ -59,7 +61,7 @@ render({
 For the client-only usage there is `/client` module. The size of this module is slightly smaller than `/client-hydratable`.
 
 ```js
-import {render} from '@divkit/divkit/client';
+import {render} from '@divkitframework/divkit/client';
 
 render({
     id: 'smth',
@@ -102,7 +104,7 @@ ES modules can be used in the browser directly without any build:
 
 ```html
 <script type="module">
-    import {render} from './node_modules/@divkit/divkit/dist/esm/client.mjs';
+    import {render} from './node_modules/@divkitframework/divkit/dist/esm/client.mjs';
 
     render({
         id: 'smth',
@@ -121,7 +123,7 @@ ES modules can be used in the browser directly without any build:
 ### Use in the browser via global variables without build:
 
 ```html
-<script src="./node_modules/@divkit/divkit/dist/browser/client.js"></script>
+<script src="./node_modules/@divkitframework/divkit/dist/browser/client.js"></script>
 <script>
     window.Ya.Divkit.render({
         id: 'smth',
@@ -137,6 +139,12 @@ ES modules can be used in the browser directly without any build:
 </script>
 ```
 
+### Usage with React
+
+There is a separate package for that.
+
+[React component package](../divkit-react)
+
 ### TypeScript and types
 
 All modules have typescript definitions (client, client-hydratable and server), so typescript will load them at any use.
@@ -155,7 +163,7 @@ Node.js
 Node.js >= 8
 ```
 
-### API
+### API: render
 
 All 3 exported modules have an exported function `render`. This function works in a similar way on client and server.
 
@@ -163,8 +171,6 @@ All 3 exported modules have an exported function `render`. This function works i
 
 Instead, `/server` module will return an HTML string.
 
-### Options
-
 #### id
 
 String, required.
@@ -280,3 +286,38 @@ Divjson along with the `card` and `templates` can contain a `palette` property w
     }
 }
 ```
+
+### API: other
+
+#### Variables
+
+```js
+import {createVariable, createGlobalVariablesController, render} from '@divkit/divkit';
+
+// Custom variable outside of DivJson
+const variable = createVariable('name', 'string', 'val');
+
+variable.subscribe(newVal => {
+    console.log(newVal);
+});
+
+// Custom scope for variables
+const controller = createGlobalVariablesController();
+
+controller.setVariable(variable);
+
+render(({
+    id: 'smth',
+    target: document.querySelector('#root'),
+    json: {},
+    globalVariablesController: controller
+});
+```
+
+---
+
+[Documentation](https://divkit.tech/doc). [Medium tutorial](https://medium.com/p/cad519252f0f). [Habr tutorial](https://habr.com/ru/company/yandex/blog/683886/).
+
+Telegram: [News](https://t.me/divkit_news) | [English-speaking chat](https://t.me/divkit_community_en) | [Чат на русском](https://t.me/divkit_community_ru).
+
+[Twitter](https://twitter.com/DivKitFramework)