aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2022-07-22 13:25:45 +0200
committerHampusM <hampus@hampusmat.com>2022-07-22 13:25:45 +0200
commit4cb3884e24b3cba3347ff93475bbabd6fe18d2fa (patch)
tree2fa5e6d81de9dc39bd11d64797914e5d305d98e2 /README.md
parent157f38bc2287dcb9a8b21ef3d5e33c569dc5136e (diff)
refactor: make factories an optional feature
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index 34358cf..94eb526 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,15 @@ From the [syrette Wikipedia article](https://en.wikipedia.org/wiki/Syrette).
## Features
- A [dependency injection](https://en.wikipedia.org/wiki/Dependency_injection) container
- Autowiring dependencies
-- Binding factories
- API inspired from the one of [InversifyJS](https://github.com/inversify/InversifyJS)
- Helpful error messages
- Enforces the use of interface traits
+## Optional features
+- Binding factories (Rust nightly required)
+
+To use these features, you must [enable it in Cargo](https://doc.rust-lang.org/cargo/reference/features.html#dependency-features).
+
## Motivation
Other DI libraries for Rust are either unmaintained ([di](https://crates.io/crates/di) for example),
overcomplicated and or bloated ([anthill-di](https://crates.io/crates/anthill-di) for example)
@@ -25,9 +29,6 @@ or has a weird API ([teloc](https://crates.io/crates/teloc) for example).
The goal of Syrette is to be a simple, useful, convenient and familiar DI library.
-## Notice
-Rust nightly is currently required.
-
## Example usage
```rust
use syrette::{injectable, DIContainer};