Skip to content

Commit 9ce12d2

Browse files
authored
Merge pull request #79 from auto-impl-rs/KodrAus-patch-1
Add a note to the readme about alternatives
2 parents e1bfc82 + 9f43421 commit 9ce12d2

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `auto_impl` [![Join the chat at https://gitter.im/auto-impl-rs/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/auto-impl-rs/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![CI](https://github.com/auto-impl-rs/auto_impl/actions/workflows/ci.yml/badge.svg)](https://github.com/auto-impl-rs/auto_impl/actions/workflows/ci.yml) [![Crates.io](https://img.shields.io/crates/v/auto_impl.svg)](https://crates.io/crates/auto_impl) [![docs](https://docs.rs/auto_impl/badge.svg)](https://docs.rs/auto_impl)
1+
# `auto_impl` [![CI](https://github.com/auto-impl-rs/auto_impl/actions/workflows/ci.yml/badge.svg)](https://github.com/auto-impl-rs/auto_impl/actions/workflows/ci.yml) [![Crates.io](https://img.shields.io/crates/v/auto_impl.svg)](https://crates.io/crates/auto_impl) [![docs](https://docs.rs/auto_impl/badge.svg)](https://docs.rs/auto_impl)
22

33
A proc-macro attribute for automatically implementing a trait for references,
44
some common smart pointers and closures.
@@ -36,8 +36,14 @@ requires_foo(&0i32); // works: through the generated impl
3636
requires_foo(Box::new(0i32)); // works: through the generated impl
3737
```
3838

39-
For more explanations, please see [**the documentation**](https://docs.rs/auto_impl) and for more examples, see [the examples folder](https://github.com/auto-impl-rs/auto_impl/tree/master/examples).
39+
For more explanations, please see [**the documentation**](https://docs.rs/auto_impl) and for more examples, see
40+
[the examples folder](https://github.com/auto-impl-rs/auto_impl/tree/master/examples).
4041

42+
# Alternatives
43+
44+
This library implements a fraction of a very broad and complex usecase. It's mostly useful for applications that
45+
define traits for components, and want to be able to abstract over the storage for those traits. If it doesn't offer
46+
some functionality you need, check out the [`impl-tools`](https://github.com/kas-gui/impl-tools/) project.
4147

4248
---
4349

0 commit comments

Comments
 (0)