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 Dec 31, 2022
1 parent c9e4f99 commit 649a952
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Dart backend framework
- [Request processing pipeline](#request-processing-pipeline)
- [Endpoints](#endpoints)
- [Api](#api)
- [Controllers](#controllers)
- [Request body](#request-body)
- [FormData](#formdata)
- [Path parameters](#path-parameters)
Expand Down Expand Up @@ -108,7 +109,8 @@ Various packages to simplify working with `Minerva`, as well as in general that
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.
- [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.

# Installing

Expand Down Expand Up @@ -366,6 +368,10 @@ class ApisBuilder extends MinervaApisBuilder {
}
```

### Controllers

Controllers are the preferred way to configure the server. You can find out more about them [here](https://pub.dev/packages/minerva_controller_generator).

### Request body

You can access the request body through the `body` field of an instance of the `MinervaRequest` class. The `body` field provides access to an instance of the `RequestBody` class.
Expand Down Expand Up @@ -1105,11 +1111,11 @@ Salt generation is available using the `generateSalt` method of the `PasswordSec
# Road map

- ✅ Finish error handling;
- 🚧 Make documentation;
- 🚧 Make more examples;
- 🔜 Cover with tests;
- 🔜 Update README files;
- 🔜 Creating video tutorials;
- Make documentation;
- Make more examples;
- 🚧 Cover with tests;
- 🚧 Update README files;
- 🚧 Creating video tutorials;
- 🔜 Add benchmarks;
- 🔜 Create documentation website.

Expand Down
18 changes: 12 additions & 6 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Dart фреймворк для создания серверов
- [Конвейер обработки запросов](#конвейер-обработки-запросов)
- [Конечные точки](#конечные-точки)
- [Api](#api)
- [Controllers](#controllers)
- [Тело запроса](#тело-запроса)
- [FormData](#formdata)
- [Параметры пути](#параметры-пути)
Expand Down Expand Up @@ -108,7 +109,8 @@ Dart фреймворк для создания серверов
Существующие в данный момент мои пакеты, которые могут вам пригодится:

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

# Установка

Expand Down Expand Up @@ -366,6 +368,10 @@ class ApisBuilder extends MinervaApisBuilder {
}
```

### Controllers

Контроллеры являются предпочтительным способо конфигурирования сервера. Подробней о них вы можете узнать [тут](https://pub.dev/packages/minerva_controller_generator).

### Тело запроса

Получить доступ к к телу запроса вы можете через поле `body` экземпляра класса `MinervaRequest`. Поле `body` предоставляет доступ к экземпляру класса `RequestBody`.
Expand Down Expand Up @@ -1105,11 +1111,11 @@ var hash = security.hashPassword(password, salt: salt);
# Дорожная карта

- ✅ Доделать обработку ошибок;
- 🚧 Сделать документацию;
- 🚧 Сделать больше примеров;
- 🔜 Покрыть тестами;
- 🔜 Дополнить README файлы;
- 🔜 Создание обучающих видео;
- Сделать документацию;
- Сделать больше примеров;
- 🚧 Покрыть тестами;
- 🚧 Дополнить README файлы;
- 🚧 Создание обучающих видео;
- 🔜 Добавить тесты производительности;
- 🔜 Создать сайт с документацией.

Expand Down

0 comments on commit 649a952

Please sign in to comment.