Browse Source

chore: adds english translation

e22m4u 11 months ago
parent
commit
3e146a9751
3 changed files with 103 additions and 20 deletions
  1. 81 0
      README-ru.md
  2. 21 19
      README.md
  3. 1 1
      package.json

+ 81 - 0
README-ru.md

@@ -0,0 +1,81 @@
+## @e22m4u/js-repository-mongodb-adapter
+
+*[English](README.md) | Русский*
+
+MongoDB адаптер для [@e22m4u/js-repository](https://www.npmjs.com/package/@e22m4u/js-repository)  
+
+## Установка
+
+```bash
+npm install @e22m4u/js-repository-mongodb-adapter
+```
+
+## Параметры
+
+Все указанные параметры опциональны:
+
+| название | значение по умолчанию |
+|----------|-----------------------|
+| protocol | `'mongodb'`           |
+| host     | `'127.0.0.1'`         |
+| port     | `27017`               |
+| database | `'database'`          |
+| username | `undefined`           |
+| password | `undefined`           |
+
+Пример:
+
+```js
+import {Schema} from '@e22m4u/js-repository';
+
+const schema = new Schema();
+
+// объявление источника
+schema.defineDatasource({
+  name: 'myMongo', // название источника
+  adapter: 'mongodb', // имя адаптера
+  // параметры
+  host: '127.0.0.1',
+  port: 27017,
+  database: 'myDatabase',
+});
+
+// объявление модели
+schema.defineModel({
+  name: 'user', // название модели
+  datasource: 'myMongo', // используемый источник (см. выше)
+  properties: { // поля модели
+    name: 'string',
+    surname: 'string',
+  },
+});
+
+// получаем репозиторий по названию модели и создаем запись
+const userRep = schema.getRepository('user');
+const user = await userRep.create({name: 'John', surname: 'Doe'});
+
+console.log(user);
+// {
+//   id: '64f3454e5e0893c13f9bf47e',
+//   name: 'John',
+//   surname: 'Doe',
+// }
+```
+
+## Тесты
+
+Запуск контейнера `mongo:latest` скриптом `setup.sh`
+
+```bash
+./setup.sh
+```
+
+Выполнение тестов
+
+```bash
+npm run test
+```
+
+## Лицензия
+
+MIT

+ 21 - 19
README.md

@@ -1,18 +1,20 @@
 ## @e22m4u/js-repository-mongodb-adapter
 
-MongoDB адаптер для [@e22m4u/js-repository](https://www.npmjs.com/package/@e22m4u/js-repository)  
+*English | [Русский](README-ru.md)*
 
-## Установка
+MongoDB adapter for [@e22m4u/js-repository](https://www.npmjs.com/package/@e22m4u/js-repository)
+
+## Installation
 
 ```bash
 npm install @e22m4u/js-repository-mongodb-adapter
 ```
 
-## Параметры
+## Configuration
 
-Все указанные параметры опциональны:
+All parameters are optional:
 
-| название | значение по умолчанию |
+| name     | default value         |
 |----------|-----------------------|
 | protocol | `'mongodb'`           |
 | host     | `'127.0.0.1'`         |
@@ -21,34 +23,34 @@ npm install @e22m4u/js-repository-mongodb-adapter
 | username | `undefined`           |
 | password | `undefined`           |
 
-Пример:
+Example:
 
 ```js
 import {Schema} from '@e22m4u/js-repository';
 
 const schema = new Schema();
 
-// объявление источника
+// define datasource
 schema.defineDatasource({
-  name: 'myMongo', // название источника
-  adapter: 'mongodb', // имя адаптера
-  // параметры
+  name: 'myMongo', // datasource name
+  adapter: 'mongodb', // adapter name
+  // configuration
   host: '127.0.0.1',
   port: 27017,
   database: 'myDatabase',
 });
 
-// объявление модели
+// define model
 schema.defineModel({
-  name: 'user', // название модели
-  datasource: 'myMongo', // используемый источник
-  properties: { // поля модели
+  name: 'user', // model name
+  datasource: 'myMongo', // datasource name (see above)
+  properties: { // model fields
     name: 'string',
     surname: 'string',
   },
 });
 
-// получаем репозиторий по названию модели и создаем запись
+// get repository by model name and create a record
 const userRep = schema.getRepository('user');
 const user = await userRep.create({name: 'John', surname: 'Doe'});
 
@@ -60,20 +62,20 @@ console.log(user);
 // }
 ```
 
-## Тесты
+## Testing
 
-Запуск контейнера `mongo:latest` скриптом `setup.sh`
+Start `mongo:latest` container using `setup.sh` script.
 
 ```bash
 ./setup.sh
 ```
 
-Выполнение тестов
+Run tests
 
 ```bash
 npm run test
 ```
 
-## Лицензия
+## License
 
 MIT

+ 1 - 1
package.json

@@ -1,7 +1,7 @@
 {
   "name": "@e22m4u/js-repository-mongodb-adapter",
   "version": "0.3.1",
-  "description": "MongoDB адаптер для @e22m4u/js-repository",
+  "description": "MongoDB adapter for @e22m4u/js-repository",
   "type": "module",
   "module": "./src/index.js",
   "main": "./dist/cjs/index.cjs",