Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
ed48fd79a1
1 changed files with 10 additions and 1 deletions
  1. 10 1
      README.md

+ 10 - 1
README.md

@@ -34,7 +34,8 @@ A[Datasource]-->B[Model]-->С[Repository];
 
 ## Пример
 
-Создаем экземпляр класса `Schema`
+Определения источников и моделей хранятся в экземпляре класса `Schema`,
+и первым шагом в проектировании системы будет создание данного экземпляра.
 
 ```js
 import {Schema} from '@e22m4u/js-repository';
@@ -42,6 +43,14 @@ import {Schema} from '@e22m4u/js-repository';
 const schema = new Schema();
 ```
 
+Интерфейс экземпляра `Schema` содержит три основных метода, два из которых
+позволяют определить источник и модель, а третий возвращает репозиторий по
+названию модели.
+
+- `defineDatasource(datasourceDef: object): this`
+- `defineModel(modelDef: object): this`
+- `getRepository(modelName: string): Repository`
+
 Создаем источник данных `myMemory`
 
 ```js