Skip to content

Commit

Permalink
fix(readme): updated readme file to reflect the recent changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
gbtb16 committed Jan 17, 2024
1 parent a1d3170 commit 69c826f
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[![kiwi](https://github.com/gbtb16/kiwi/actions/workflows/kiwi.yml/badge.svg?branch=master)](https://github.com/gbtb16/kiwi/actions/workflows/kiwi.yml)
[![kiwi_generator](https://github.com/gbtb16/kiwi/actions/workflows/kiwi_generator.yml/badge.svg?branch=master)](https://github.com/gbtb16/kiwi/actions/workflows/kiwi_generator.yml)
[![flutter_example](https://github.com/gbtb16/kiwi/actions/workflows/flutter_example.yml/badge.svg?branch=master)](https://github.com/gbtb16/kiwi/actions/workflows/flutter_example.yml)
[![example](https://github.com/gbtb16/kiwi/actions/workflows/example.yml/badge.svg?branch=master)](https://github.com/gbtb16/kiwi/actions/workflows/example.yml)
[![dart_kiwi_example](https://github.com/gbtb16/kiwi/actions/workflows/dart_kiwi_example.yml/badge.svg?branch=master)](https://github.com/gbtb16/kiwi/actions/workflows/dart_kiwi_example.yml)
[![flutter_kiwi_example](https://github.com/gbtb16/kiwi/actions/workflows/flutter_kiwi_example.yml/badge.svg?branch=master)](https://github.com/gbtb16/kiwi/actions/workflows/flutter_kiwi_example.yml)

![Logo](https://raw.githubusercontent.com/gbtb16/kiwi/master/images/logo.png)

Expand All @@ -13,39 +13,35 @@ The container does not rely on reflection, it's just a `Map`, so it's fast.

While using the generator, only constructor injection is supported.

**IMPORTANT: Dart2 is required to use this package.**

**IMPORTANT: From 1.0.0 Container is removed. Use KiwiContainer instead. (better Flutter support)**

## KiwiContainer and annotations
## Kiwi

[![Pub](https://img.shields.io/pub/v/kiwi.svg)](https://pub.dartlang.org/packages/kiwi)

[Source Code](https://github.com/gbtb16/kiwi/tree/master/kiwi)
[Source Code](https://github.com/gbtb16/kiwi/tree/master/packages/kiwi)

The core package providing the IoC container and the annotations which has no dependencies.

Import it into your pubspec `dependencies:` section.

## Generator
## Kiwi Generator

[![Pub](https://img.shields.io/pub/v/kiwi_generator.svg)](https://pub.dartlang.org/packages/kiwi_generator)

[Source Code](https://github.com/gbtb16/kiwi/tree/master/kiwi_generator)
[Source Code](https://github.com/gbtb16/kiwi/tree/master/packages/kiwi_generator)

The package providing the generator.

Import it into your pubspec `dev_dependencies:` section.

## Example
## Dart Kiwi Example

[Source Code](https://github.com/gbtb16/kiwi/tree/master/example)
[Source Code](https://github.com/gbtb16/kiwi/tree/master/examples/dart_kiwi)

An example showing how to setup `kiwi` and `kiwi_generator`.
An example showing how to setup `kiwi` and `kiwi_generator` inside a Dart CLI project.

## Flutter Example
## Flutter Kiwi Example

[Source Code](https://github.com/gbtb16/kiwi/tree/master/flutter_example)
[Source Code](https://github.com/gbtb16/kiwi/tree/master/examples/flutter_kiwi)

An example showing how to setup `kiwi` and `kiwi_generator` inside a Flutter project.

Expand Down

0 comments on commit 69c826f

Please sign in to comment.