README.md
1![Build](https://github.com/colin-kiegel/rust-derive-builder/workflows/Build/badge.svg?branch=master)
2[![Documentation](https://docs.rs/derive_builder_core/badge.svg)](https://docs.rs/derive_builder_core)
3[![Latest version](https://img.shields.io/crates/v/derive_builder_core.svg)](https://crates.io/crates/derive_builder_core)
4[![All downloads](https://img.shields.io/crates/d/derive_builder_core.svg)](https://crates.io/crates/derive_builder_core)
5[![Downloads of latest version](https://img.shields.io/crates/dv/derive_builder_core.svg)](https://crates.io/crates/derive_builder_core)
6
7# Crate [`derive_builder_core`]
8
9**Important Note**:
10
11* You are probably looking for the [`derive_builder`] crate,
12 which wraps this crate and is much more ergonomic to use.
13* The API of this crate might **change frequently** in the near future.
14 The [`derive_builder`] crate also provides a much more stable API.
15
16## Purpose
17
18This is an internal helper library of [`derive_builder`]. Its purpose is to
19allow [`derive_builder`] to use its own code generation technique, if needed.
20
21[`derive_builder_core`] might also be used in crates that [`derive_builder`]
22depends on - to break a dependency cycle.
23
24If [`derive_builder`] does not itself depend on _your_ crate, then you
25should consider using [`derive_builder`] instead of [`derive_builder_core`].
26
27[`derive_builder`]: https://crates.io/crates/derive_builder
28[`derive_builder_core`]: https://crates.io/crates/derive_builder_core
29
30## Documentation
31
32Please refer to
33[docs.rs/derive_builder_core](https://docs.rs/derive_builder_core)
34for the documentation of all published versions.
35
36## [Changelog](CHANGELOG.md)
37
38Yes, we keep a changelog.
39
40## License
41
42Licensed under either of
43
44- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
45- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
46
47at your option.
48
49### Contribution
50
51Unless you explicitly state otherwise, any contribution intentionally
52submitted for inclusion in the work by you, as defined in the Apache-2.0
53license, shall be dual licensed as above, without any additional terms or
54conditions.
55