added documentation

README.md

@@ -2,6 +2,9 @@
 
 Экспериментальная разработка DI на ЯП Dart
 
+- [New Api ENG](/doc/quick_start_en.md)
+- [New Api RU](/doc/quick_start_ru.md)
+
 ## Документация
 
 ### Быстрый старт

doc/quick_start_ru.md

@@ -0,0 +1,195 @@
+# Быстрый старт
+
+## Основные компоненты DI
+
+
+### Binding
+
+Binding - по сути это конфигуратор  для  пользовательского instance, который соддержит методы для конфигурирования зависимости.
+
+Есть два основных метода для инициализации пользовательского instance `toInstance()` и `toProvide()` и вспомогательных `withName()` и `singeltone()`.
+
+`toInstance()` - принимает готовый экземпляр
+
+`toProvide()` -  принимает функцию `provider` (конструктор экземпляра)
+
+`withName()` - принимает строку для именования экземпляра. По этому имени можно будет извлечь instance из  DI контейнера
+
+`singeltone()` -  устанавливает флаг в Binding, который говорит DI контейнеру, что зависимость одна. По этому имени можно будет извлечь instance из  DI контейнера. Об
+
+Пример:
+
+```dart
+ // инициализация экземпляра текстовой строки через метод toInstance()
+ Binding<String>().toInstance("hello world");
+
+ // или
+
+ // инициализация экземпляра текстовой строки
+ Binding<String>().toProvide(() => "hello world");
+
+ // инициализация экземпляра строки с именем
+ Binding<String>().withName("my_string").toInstance("hello world");
+ // или
+ Binding<String>().withName("my_string").toProvide(() => "hello world");
+
+ // инициализация экземпляра, как сингелтон
+ Binding<String>().toInstance("hello world");
+ // или
+ Binding<String>().toProvide(() => "hello world").singeltone();
+
+```
+
+### Module
+
+Module - это контейнер пользовательских instances, и на основе которого пользователь может создавать свои модули. Пользователь в своем модуле должен реализовать метод `void builder(Scope currentScope)`.
+
+
+Пример:
+
+```dart
+class AppModule extends Module {
+  @override
+  void builder(Scope currentScope) {
+    bind<ApiClient>().toInstance(ApiClientMock());
+  }
+}
+```
+
+### Scope
+
+Scope - это контейнер, который хранит все дерево зависимостей (scope,modules,instances).
+Через scope можно получить доступ к `instance`, для этого нужно вызвать метод `resolve<T>()` и указать тип объекта, а так же можно передать дополнительные параметры.
+
+Пример:
+
+```dart
+    // открыть главный scope
+    final rootScope =  DartDi.openRootScope();
+
+    // инициализация scope пользовательским модулем
+    rootScope.installModules([AppModule()]);
+
+    // получаем экземпляр класса 
+    final str = rootScope.resolve<String>();
+    // или
+    final str = rootScope.tryResolve<String>();
+
+    // закрыть главный scope
+    DartDi.closeRootScope();
+```
+
+## Пример приложения
+
+
+```dart
+import 'dart:async';
+import 'package:meta/meta.dart';
+import 'package:dart_di/experimental/scope.dart';
+import 'package:dart_di/experimental/module.dart';
+
+class AppModule extends Module {
+  @override
+  void builder(Scope currentScope) {
+    bind<ApiClient>().withName("apiClientMock").toInstance(ApiClientMock());
+    bind<ApiClient>().withName("apiClientImpl").toInstance(ApiClientImpl());
+  }
+}
+
+class FeatureModule extends Module {
+  bool isMock;
+
+  FeatureModule({required this.isMock});
+
+  @override
+  void builder(Scope currentScope) {
+    bind<DataRepository>()
+        .withName("networkRepo")
+        .toProvide(
+          () => NetworkDataRepository(
+            currentScope.resolve<ApiClient>(
+              named: isMock ? "apiClientMock" : "apiClientImpl",
+            ),
+          ),
+        )
+        .singeltone();
+    bind<DataBloc>().toProvide(
+      () => DataBloc(
+        currentScope.resolve<DataRepository>(named: "networkRepo"),
+      ),
+    );
+  }
+}
+
+void main() async {
+  final scope = openRootScope().installModules([
+    AppModule(),
+  ]);
+
+  final subScope = scope
+      .openSubScope("featureScope")
+      .installModules([FeatureModule(isMock: true)]);
+
+  final dataBloc = subScope.resolve<DataBloc>();
+  dataBloc.data.listen((d) => print('Received data: $d'),
+      onError: (e) => print('Error: $e'), onDone: () => print('DONE'));
+
+  await dataBloc.fetchData();
+}
+
+class DataBloc {
+  final DataRepository _dataRepository;
+
+  Stream<String> get data => _dataController.stream;
+  StreamController<String> _dataController = new StreamController.broadcast();
+
+  DataBloc(this._dataRepository);
+
+  Future<void> fetchData() async {
+    try {
+      _dataController.sink.add(await _dataRepository.getData());
+    } catch (e) {
+      _dataController.sink.addError(e);
+    }
+  }
+
+  void dispose() {
+    _dataController.close();
+  }
+}
+
+abstract class DataRepository {
+  Future<String> getData();
+}
+
+class NetworkDataRepository implements DataRepository {
+  final ApiClient _apiClient;
+  final _token = 'token';
+
+  NetworkDataRepository(this._apiClient);
+
+  @override
+  Future<String> getData() async => await _apiClient.sendRequest(
+      url: 'www.google.com', token: _token, requestBody: {'type': 'data'});
+}
+
+abstract class ApiClient {
+  Future sendRequest({@required String url, String token, Map requestBody});
+}
+
+class ApiClientMock implements ApiClient {
+  @override
+  Future sendRequest(
+      {@required String? url, String? token, Map? requestBody}) async {
+    return 'Local Data';
+  }
+}
+
+class ApiClientImpl implements ApiClient {
+  @override
+  Future sendRequest(
+      {@required String? url, String? token, Map? requestBody}) async {
+    return 'Network data';
+  }
+}
+```