#35 Update readme

Author: Andrii Kirmas

README.md

@@ -241,7 +241,40 @@ Default options BEM naming:
 - Modifier's and value's separator is a double hyphen `"--"`
 - Element's separator is a double underscore `"__"`
 
-It is required to change this options twice, both on JS (`setOpts(...)`) and TS `namespace ReactClassNaming { interface BemOptions {...} }`) levels. See [./\__recipes__/](https://github.com/askirmas/react-classnaming/tree/main/__recipes__/)
+It is required to change this options twice, both on JS and TS levels. 
+
+- TS: in declaration file like [\./\__recipes\__/global.d.ts](https://github.com/askirmas/react-classnaming/blob/main/__recipes__/global.d.ts) you to add those lines:
+
+```typescript
+/// <reference types="react-classnaming" />
+declare namespace ReactClassNaming {
+  interface BemOptions {
+    elementDelimiter: "_";
+    modDelimiter: "-";
+  }
+}
+```
+
+And optionally in add to *tsconfig.json*:
+
+```diff
+  "compilerOptions": {
+    "types": [
++     "react-classnaming"
+    ]
+  }
+```
+
+
+
+- JS: [./\__recipes\__/index.test.ts#L2-L7](https://github.com/askirmas/react-classnaming/blob/main/__recipes__/index.test.ts#L2-L7)
+
+  ```typescript
+  import setOptions from "react-classnaming"
+  setOptions({...})
+  ```
+
+  
 
 ### function [`classNamesMap`](https://github.com/askirmas/react-classnaming/projects/5)
 

__recipes__/global.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="react-classnaming" />
-
 declare namespace ReactClassNaming {
   interface BemOptions {
     elementDelimiter: "_";

__recipes__/index.test.ts

@@ -1,5 +1,5 @@
-import {classBeming, ClassNamed, ClassNamesProperty, setOptions} from "react-classnaming"
-import type {ClassHash} from "react-classnaming"
+import type {ClassHash, ClassNamed, ClassNamesProperty} from "react-classnaming"
+import {classBeming, setOptions} from "react-classnaming"
 
 setOptions({
   elementDelimiter: "_",

__recipes__/tsconfig.json

@@ -1,8 +1,7 @@
 {
   "compilerOptions": {
     "types": [
-      "jest",
-      "react-classnaming"
+      "jest"
     ]
   },
   "exclude": [

src/bem.test.ts

@@ -1,4 +1,4 @@
-import { classBeming } from "./bem";
+import { classBeming, setOptions } from "./bem";
 import { ClassHash } from "./definitions.types";
 import { ClassNamed, ClassNamesProperty } from "./main.types";
 
@@ -53,3 +53,5 @@ it("TS UX", () => {
 
     expect(check).toBeInstanceOf(Object)
 })
+
+it("cover reexported", () => expect(setOptions).toThrow())

src/bem.ts

@@ -4,6 +4,7 @@ import { bem2arr } from "./bem.core";
 import { joinWithLead, picker, wrapper } from "./core"
 import { EMPTY_OBJECT } from "./consts.json"
 
+export {setOptions} from "./bem.core"
 export {
   classBeming
 }

src/global.d.ts

@@ -1,6 +1,11 @@
 /**
  * Tools to establish CSS classes as an explicit abstraction layer and to handle it as an interface between React and CSSStyleDeclaration
  * GitHub: https://github.com/askirmas/react-classnaming
+ * 
+ * Contains:
+ * ```typescript
+ * interface BemOptions {}
+ * ```
  */
 declare namespace ReactClassNaming {
 /**
@@ -14,7 +19,6 @@ declare namespace ReactClassNaming {
  * ```
  */
   interface BemOptions {
-
     $default: {
       elementDelimiter: "__",
       modDelimiter: "--"