Skip to content

Commit

Permalink
update documentation and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ivlevAstef committed Dec 25, 2024
1 parent 56d2d8f commit 17ea2e1
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 30 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# 5.0.0
* Beta Support Swift Concurrency for DITranquillity and SwiftLazy.
* Update SwiftLazy - fix and optimize Lazy.
* Update SwiftLazy - Lazy support @dynamicMemberLookup

# 4.7.0
* Update SwiftLazy for fix deadlock in Lazy. BUT this update can crash application if use Lazy.

# 4.6.0
* Support Variadic types/generics: https://github.com/apple/swift-evolution/blob/main/proposals/0398-variadic-types.md
Now register and injection have infinity paramaters.
Expand Down
30 changes: 12 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<a href="https://github.com/Carthage/Carthage"><img src ="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat"/></a>
<a href="https://swift.org/package-manager"><img src ="https://img.shields.io/badge/SwiftPM-compatible-4BC51D.svg?style=flat"/></a>
<a href="https://github.com/ivlevAstef/DITranquillity/blob/master/LICENSE"><img src ="https://img.shields.io/github/license/ivlevAstef/DITranquillity.svg?maxAge=2592000"/></a>
<a href="https://developer.apple.com/swift"><img src ="https://img.shields.io/badge/Swift-3.0--5.9-F16D39.svg?style=flat"/></a>
<a href="https://developer.apple.com/swift"><img src ="https://img.shields.io/badge/Swift-3.0--6.0-F16D39.svg?style=flat"/></a>
<a href="http://cocoapods.org/pods/DITranquillity"><img src ="https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20Linux-lightgrey.svg"/></a>
<a href="https://codecov.io/gh/ivlevAstef/DITranquillity"><img src ="https://codecov.io/gh/ivlevAstef/DITranquillity/branch/master/graph/badge.svg"/></a>
</p>
Expand Down Expand Up @@ -40,6 +40,7 @@ Also I recommend you to read [Glossary](Documentation/en/glossary.md) which will
- [x] [Modular](Documentation/en/core/modular.md)
- [x] [Details logs](Documentation/en/core/logs.md)
- [x] Thread safety
- [x] Swift Concurrency
- [x] [Container hierarchy](Documentation/en/core/container_hierarchy.md)
#### UI
- [x] [Storyboard and StoryboardReferences](Documentation/en/ui/storyboard.md)
Expand All @@ -51,12 +52,7 @@ Also I recommend you to read [Glossary](Documentation/en/glossary.md) which will

## Installing
The library supports three popular package managers: Cocoapods, Carthage, SwiftPM.

#### CocoaPods
Add the following lines to your `Podfile`:
```
pod 'DITranquillity'
```
Cocoapods unsupport from 5.0.0 library version.

#### SwiftPM
You can use "Xcode/File/Swift Packages/Add Package Dependency..." and write github url:
Expand All @@ -66,20 +62,24 @@ https://github.com/ivlevAstef/DITranquillity

Also you can edit your `Package.swift` and the following line into section `dependencies`:
```Swift
.package(url: "https://github.com/ivlevAstef/DITranquillity.git", from: "4.6.0")
.package(url: "https://github.com/ivlevAstef/DITranquillity.git", from: "5.0.0")
```
And don't forget to specify in your section `target` wrote dependency line:
```Swift
.product(name: "DITranquillity")
```
> Attention! - SwiftPM unsupport features from the "UI" section.

#### CocoaPods
Add the following lines to your `Podfile`:
```
pod 'DITranquillity'
```

#### Carthage
Add the following lines to your `Cartfile`:
```
github "ivlevAstef/DITranquillity"
```
Carthage support "UI" and "GraphAPI" section no additional actions.

## Usage
The library uses a declarative style of dependency description, and allows you to separate your application code from dependency description code.
Expand Down Expand Up @@ -204,8 +204,9 @@ Also your can read articles:
* Ru! Old! [https://habr.com/ru/post/311334/](https://habr.com/ru/post/311334/)

## Requirements
iOS 11.0+,macOS 10.13+,tvOS 11.0+, watchOS 4.0+, Linux; ARC
iOS 13.0+,macOS 10.15+,tvOS 13.0+, watchOS 8.0+, Linux; ARC

* Swift 6.0-6.x: Xcode 16; version >= 5.0.0
* Swift 5.5-5.9: Xcode 13,14,15; version >= 3.6.3
* Swift 5.0-5.3: Xcode 10.2-12.x; version >= 3.6.3
* Swift 4.2: Xcode 10; version >= 3.4.3
Expand All @@ -217,13 +218,6 @@ iOS 11.0+,macOS 10.13+,tvOS 11.0+, watchOS 4.0+, Linux; ARC
## Changelog
See [CHANGELOG](CHANGELOG.md) file or [releases](https://github.com/ivlevAstef/DITranquillity/releases).

## History and Plans
- [x] v1.x.x - Started
- [x] v2.x.x - Stabilization
- [x] v3.x.x - Evolution and Features
- [ ] v4.x.x - Graph API and Optimization. Also Documentation and Marketing
- [ ] v5.x.x - Pre compile time validation

## Feedback

### I've found a bug, or have a feature request
Expand Down
25 changes: 13 additions & 12 deletions README_ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<a href="https://github.com/Carthage/Carthage"><img src ="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat"/></a>
<a href="https://swift.org/package-manager"><img src ="https://img.shields.io/badge/SwiftPM-compatible-4BC51D.svg?style=flat"/></a>
<a href="https://github.com/ivlevAstef/DITranquillity/blob/master/LICENSE"><img src ="https://img.shields.io/github/license/ivlevAstef/DITranquillity.svg?maxAge=2592000"/></a>
<a href="https://developer.apple.com/swift"><img src ="https://img.shields.io/badge/Swift-3.0--5.9-F16D39.svg?style=flat"/></a>
<a href="https://developer.apple.com/swift"><img src ="https://img.shields.io/badge/Swift-3.0--6.0-F16D39.svg?style=flat"/></a>
<a href="http://cocoapods.org/pods/DITranquillity"><img src ="https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20Linux-lightgrey.svg"/></a>
<a href="https://codecov.io/gh/ivlevAstef/DITranquillity"><img src ="https://codecov.io/gh/ivlevAstef/DITranquillity/branch/master/graph/badge.svg"/></a>
</p>
Expand Down Expand Up @@ -39,6 +39,7 @@
- [x] [Поддержка модульности](Documentation/ru/core/modular.md)
- [x] [Полное и подробное логирование](Documentation/ru/core/logs.md)
- [x] Одновременная работа из нескольких потоков
- [x] Swift Concurrency
- [x] [Иерархичные контейнеры](Documentation/ru/core/container_hierarchy.md)
#### UI
- [x] [Поддержка сторибоардов](Documentation/ru/ui/storyboard.md)
Expand All @@ -50,12 +51,7 @@

## Установка
Библиотека поддерживает три популярных пакетных менеджера: Cocoapods, Carthage, SwiftPM.

#### CocoaPods
Добавьте строчку в ваш `Podfile`:
```
pod 'DITranquillity'
```
Начиная с версии 5.0.0 Cocoapods не поддерживается.

#### SwiftPM
Вы можете воспользуйтесь "Xcode/File/Swift Packages/Add Package Dependency..." и указать в качестве url:
Expand All @@ -70,14 +66,18 @@ https://github.com/ivlevAstef/DITranquillity
```Swift
.product(name: "DITranquillity")
```
> Важно! - SwiftPM не поддерживает фичи из секции UI.

#### CocoaPods
Добавьте строчку в ваш `Podfile`:
```
pod 'DITranquillity'
```

#### Carthage
Добавьте строчку в ваш `Cartfile`:
```
github "ivlevAstef/DITranquillity"
```
Carthage поддерживает работу со сторибоардами графом и прямое внедрение, без дополнительных действий.

## Использование
Библиотека использует декларативный стиль описания зависимостей, и позволяет отделить ваш прикладной код от кода описания зависимостей.
Expand Down Expand Up @@ -202,8 +202,9 @@ class AuthInteractorImpl: AuthInteractor {
* Старая [https://habr.com/ru/post/311334/](https://habr.com/ru/post/311334/)

## Требования
iOS 11.0+,macOS 10.13+,tvOS 11.0+, watchOS 4.0+, Linux; ARC
iOS 13.0+,macOS 10.15+,tvOS 13.0+, watchOS 8.0+, Linux; ARC

* Swift 6.0-6.x: Xcode 16; version >= 5.0.0
* Swift 5.5-5.9: Xcode 13,14,15; version >= 3.6.3
* Swift 5.0-5.3: Xcode 10.2-12.x; version >= 3.6.3
* Swift 4.1: Xcode 9.3; version >= 3.2.3
Expand All @@ -218,8 +219,8 @@ iOS 11.0+,macOS 10.13+,tvOS 11.0+, watchOS 4.0+, Linux; ARC
- [x] v1.x.x - Начальная версия
- [x] v2.x.x - Стабилизация [миграция с первой](Documentation/ru/migration1to2.md)
- [x] v3.x.x - Эволюция и фичи [миграция со второй](Documentation/ru/migration2to3.md)
- [ ] v4.x.x - API получения графа, оптимизация, Обновление документации и маркетинг [миграция с третьей](Documentation/ru/migration3to4.md)
- [ ] v5.x.x - Перенос валидации графа, и других проверок на этап компиляции
- [x] v4.x.x - Оптимизация [миграция с третьей](Documentation/ru/migration3to4.md)
- [ ] v5.x.x - Swift Concurrency

## Обратная связь

Expand Down

0 comments on commit 17ea2e1

Please sign in to comment.