Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
e7cabeee54
1 changed files with 21 additions and 0 deletions
  1. 21 0
      README.md

+ 21 - 0
README.md

@@ -2,6 +2,27 @@
 
 
 Модуль для работы с базами данных для Node.js
 Модуль для работы с базами данных для Node.js
 
 
+## Установка
+
+```bash
+npm install @e22m4u/js-repository
+```
+
+Опционально устанавливаем адаптер. Например, если используется
+*MongoDB*, то для подключения потребуется установить
+[адаптер mongodb](https://www.npmjs.com/package/@e22m4u/js-repository-mongodb-adapter)
+как отдельную зависимость.
+
+```bash
+npm install @e22m4u/js-repository-mongodb-adapter
+```
+
+Список адаптеров:
+
+|           | описание                                                                                                                       |
+|-----------|--------------------------------------------------------------------------------------------------------------------------------|
+| `memory`  | виртуальная база в памяти процесса (не требует установки)                                                                      |
+| `mongodb` | MongoDB - система управления NoSQL базами (*[установка](https://www.npmjs.com/package/@e22m4u/js-repository-mongodb-adapter))* |
 
 
 ## Тесты
 ## Тесты