xref: /aosp_15_r20/external/truth/README.md (revision b3996a89512f34bffd8f9a69f0bc726f1b19016a)
1[![Main Site][gh-pages-shield]][gh-pages-link]
2[![Build Status][ci-shield]][ci-link]
3[![Maven Release][maven-shield]][maven-link]
4[![Stackoverflow][stackoverflow-shield]][stackoverflow-link]
5
6## What is Truth?
7
8Truth makes your [test assertions] and [failure messages] more readable.
9[Similar][comparison] to [AssertJ], it [natively supports][known_types] many JDK
10and [Guava] types, and it is [extensible][extension] to others.
11
12Truth is owned and maintained by the [Guava] team. It is used in the majority
13of the tests in Google’s own codebase.
14
15Read more at [the main website](https://truth.dev).
16
17<!-- references -->
18
19[test assertions]: https://truth.dev/benefits#readable-assertions
20[failure messages]: https://truth.dev/benefits#readable-messages
21[comparison]: https://truth.dev/comparison
22[AssertJ]: http://joel-costigliola.github.io/assertj/
23[known_types]: https://truth.dev/known_types
24[extension]: https://truth.dev/extension
25[Guava]: https://github.com/google/guava
26[gh-pages-shield]: https://img.shields.io/badge/main%20site-truth.dev-ff55ff.png?style=flat
27[gh-pages-link]: https://truth.dev/
28[ci-shield]: https://github.com/google/truth/workflows/CI/badge.svg?branch=master
29[ci-link]: https://github.com/google/truth/actions
30[maven-shield]: https://img.shields.io/maven-central/v/com.google.truth/truth.png
31[maven-link]: https://search.maven.org/artifact/com.google.truth/truth
32[stackoverflow-shield]: https://img.shields.io/badge/stackoverflow-googletruth-5555ff.png?style=flat
33[stackoverflow-link]: https://stackoverflow.com/questions/tagged/google-truth
34