Skip to content

Commit

Permalink
Format README.md.
Browse files Browse the repository at this point in the history
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=276739948
  • Loading branch information
cpovirk authored and cgdecker committed Oct 28, 2019
1 parent 3d33cd4 commit ab5b0fa
Showing 1 changed file with 24 additions and 25 deletions.
49 changes: 24 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Guava's Maven group ID is `com.google.guava` and its artifact ID is `guava`.
Guava provides two different "flavors": one for use on a (Java 8+) JRE and one
for use on Android or Java 7 or by any library that wants to be compatible with
either of those. These flavors are specified in the Maven version field as
either `28.1-jre` or `28.1-android`. For more about depending on
Guava, see [using Guava in your build].
either `28.1-jre` or `28.1-android`. For more about depending on Guava, see
[using Guava in your build].

To add a dependency on Guava using Maven, use the following:

Expand Down Expand Up @@ -72,7 +72,8 @@ flavor.
## Learn about Guava

- Our users' guide, [Guava Explained]
- [A nice collection](http://www.tfnico.com/presentations/google-guava) of other helpful links
- [A nice collection](http://www.tfnico.com/presentations/google-guava) of
other helpful links

## Links

Expand All @@ -84,36 +85,34 @@ flavor.

## IMPORTANT WARNINGS

1. APIs marked with the `@Beta` annotation at the class or method level
are subject to change. They can be modified in any way, or even
removed, at any time. If your code is a library itself (i.e. it is
used on the CLASSPATH of users outside your own control), you should
not use beta APIs, unless you [repackage] them. **If your
code is a library, we strongly recommend using the [Guava Beta Checker] to
ensure that you do not use any `@Beta` APIs!**
1. APIs marked with the `@Beta` annotation at the class or method level are
subject to change. They can be modified in any way, or even removed, at any
time. If your code is a library itself (i.e. it is used on the CLASSPATH of
users outside your own control), you should not use beta APIs, unless you
[repackage] them. **If your code is a library, we strongly recommend using
the [Guava Beta Checker] to ensure that you do not use any `@Beta` APIs!**

2. APIs without `@Beta` will remain binary-compatible for the indefinite
future. (Previously, we sometimes removed such APIs after a deprecation period.
The last release to remove non-`@Beta` APIs was Guava 21.0.) Even `@Deprecated`
APIs will remain (again, unless they are `@Beta`). We have no plans to start
removing things again, but officially, we're leaving our options open in case
of surprises (like, say, a serious security problem).
future. (Previously, we sometimes removed such APIs after a deprecation
period. The last release to remove non-`@Beta` APIs was Guava 21.0.) Even
`@Deprecated` APIs will remain (again, unless they are `@Beta`). We have no
plans to start removing things again, but officially, we're leaving our
options open in case of surprises (like, say, a serious security problem).

3. Guava has one dependency that is needed at runtime:
`com.google.guava:failureaccess:1.0.1`
`com.google.guava:failureaccess:1.0.1`

4. Serialized forms of ALL objects are subject to change unless noted
otherwise. Do not persist these and assume they can be read by a
future version of the library.
otherwise. Do not persist these and assume they can be read by a future
version of the library.

5. Our classes are not designed to protect against a malicious caller.
You should not use them for communication between trusted and
untrusted code.
5. Our classes are not designed to protect against a malicious caller. You
should not use them for communication between trusted and untrusted code.

6. For the mainline flavor, we unit-test the libraries using only OpenJDK 1.8 on
Linux. Some features, especially in `com.google.common.io`, may not work
correctly in other environments. For the Android flavor, our unit tests run on
API level 15 (Ice Cream Sandwich).
6. For the mainline flavor, we unit-test the libraries using only OpenJDK 1.8
on Linux. Some features, especially in `com.google.common.io`, may not work
correctly in other environments. For the Android flavor, our unit tests run
on API level 15 (Ice Cream Sandwich).

[guava-snapshot-api-docs]: https://google.github.io/guava/releases/snapshot-jre/api/docs/
[guava-snapshot-api-diffs]: https://google.github.io/guava/releases/snapshot-jre/api/diffs/
Expand Down

0 comments on commit ab5b0fa

Please sign in to comment.