Dictionary init

Author: SrPumpkin

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-present Dan Abramov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,120 @@
+
+# Dictionary
+
+Dictionary is a JS library that helps automate language switching.
+
+This library can greatly speed up the development of language versions for any type of application. This library is new and requires a lot of improvements, but you can already try it out. Initially, it was supposed to use Dictionary with React.
+
+
+## Installation
+
+To install, use:
+
+```bash
+  npm install dictionary
+```
+
+
+## How to use
+
+First, we create JSON files where all data that is subject to language change will be stored.
+```javascript
+//For English lang
+{
+    "title": "Dictionary"
+}
+
+//And for Deutschland lang
+{
+    "title": "Wörterbuch"
+}
+```
+
+If the text should contain some dynamic parameter, add `<d.*someVariable*>` to this place, where `someVariable` is an identifier that is used to replace this section with the parameter being passed.
+```javascript
+// You can type any param name "param" or "num" or "sometrash". Wherever you want.
+{
+    "text": "Text for <d.param> exemple"
+}
+```
+
+There may be several such parameters.
+```javascript
+{
+    "text": "Text <d.num> for <d.param> exemple <d.param>"
+}
+```
+
+Then we create an index file and create a dictionary.
+```javascript
+const initialState = {
+    en: english,
+    de: deutschland
+}
+
+export const dictionaryLangs = createDictionary(initialState)
+```
+
+To access the dictionary at the top level of the application, we need to connect our dictionary.
+```javascript
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import App from './App';
+
+import { Dictionary } from "./Dictionary";
+import { dictionaryLangs } from "./dictionary/dictionaryLangs";
+
+const root = ReactDOM.createRoot(
+    document.getElementById('main') as HTMLElement
+);
+
+root.render(
+    <Dictionary languages={dictionaryLangs}>
+        <App />
+    </Dictionary>
+);
+```
+
+After that, to get data from the dictionary, we call the `useDictionary()` function.
+```javascript
+// {} in the second parameter is required
+const title = useDictionary(state => state.title, {}),
+```
+
+Here I should say that the dictionary selects the first language you added as the main one.
+
+If the text contains a parameter that needs to be replaced, we pass it as the second argument.
+```javascript
+// Here we should use only those parameters that we have noted in the text.
+const text = useDictionary(state => state.text, {param: "some param", num: 2}),
+```
+
+To change the language, you need to initialize the `useLangChanger()` function and then pass the name of the language you added earlier as an argument.
+```javascript
+const changeLang = useLangChanger()
+
+const handleClick = () => {
+    changeLang("de")
+}
+```
+
+Congratulations, you are amazing.
+
+
+
+## Features
+
+- Code optimization
+- Possibility to obtain processed data for the entire section at once
+
+
+
+## Authors
+
+- [@SrPumpkin](https://www.github.com/SrPumpkin)
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+