Skip to content

Commit

Permalink
Updates README files
Browse files Browse the repository at this point in the history
  • Loading branch information
Gleb Batykov committed Apr 17, 2023
1 parent 31c5813 commit 723d276
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ Currently existing my packages that may be useful to you:

- [emerald](https://pub.dev/packages/emerald) - `JSON` serializer/deserializer, based on `dart:mirrors`, works only with `JIT` compilation type;
- [mcache](https://pub.dev/packages/mcache) - package for caching values. Supports deleting values after their expiration date;
- [minerva_controller_generator](https://pub.dev/packages/minerva_controller_generator ) - the package allows you to configure the server using controllers built on code generation.
- [minerva_mcache](https://pub.dev/packages/minerva_mcache) - package for integration [mcache](https://pub.dev/packages/mcache) package in the `Minerva` framework. Contains tools that allow you to work from different server instances with shared cache located in the agent;
- [minerva_controller_generator](https://pub.dev/packages/minerva_controller_generator) - the package allows you to configure the server using controllers built on code generation.

# Installing

Expand All @@ -104,7 +105,7 @@ Installing `Minerva`:
dart pub global activate minerva
```

Create project and run example:
Create project with standart template (controllers) and run example:

```dart
minerva create -n my_application
Expand All @@ -116,6 +117,18 @@ dart pub run build_runner build
minerva run
```

Create project with endpoints template and run example:

```dart
minerva create -n my_application -t endpoints
cd my_application
dart pub run build_runner build
minerva run
```

# CLI

The framework contains the `CLI` utility `Minerva`, which contains the following commands:
Expand Down
13 changes: 12 additions & 1 deletion README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Dart фреймворк для создания серверов

- [emerald](https://pub.dev/packages/emerald) - `JSON` сериализатор/десериализатор, основан на `dart:mirros`, работает только с `JIT` типом компиляции;
- [mcache](https://pub.dev/packages/mcache) - пакет для кэширования значений. Поддерживает удаление значение по истечению их срока жизни;
- [minerva_mcache](https://pub.dev/packages/minerva_mcache) - пакет для интеграции [mcache](https://pub.dev/packages/mcache) пакета в `Minerva` фреймворк. Содержит средства позволяющие работать из разных экземпляров сервера с общим кэшем находящимся в агенте;
- [minerva_controller_generator](https://pub.dev/packages/minerva_controller_generator) - пакет позволяет конфигурировать сервер при помощи контроллеров, построенных на генерации кода.

# Установка
Expand All @@ -104,7 +105,7 @@ Dart фреймворк для создания серверов
dart pub global activate minerva
```

Создать проект и запустить пример:
Создать проект с стандартным шаблоном по умолчанию (controllers) и запустить пример:

```dart
minerva create -n my_application
Expand All @@ -116,6 +117,16 @@ dart pub run build_runner build
minerva run
```

Создать проект с шаблоном endpoints и запустить пример:

```dart
minerva create -n my_application -t endpoints
cd my_application
minerva run
```

# Консольная утилита

Фреймворк содержит `CLI` утилиту `Minerva`, которая содержит следующие команды:
Expand Down

0 comments on commit 723d276

Please sign in to comment.