Skip to content

Commit e836a51

Browse files
authored
add explicit public API definition (#97)
* add explicit public API definition * copyedit * tweak public API definition
1 parent a600292 commit e836a51

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,13 @@ public class StringExample {
138138

139139
You can find more examples in the [examples directory][examples].
140140

141+
## Public API
142+
143+
Our [versioning policy](./VERSIONING.rst) applies to all public and protected classes/methods/fields
144+
in the `com.amazonaws.encryptionsdk` package unless otherwise documented.
145+
146+
The `com.amazonaws.encryptionsdk.internal` package is not included in this public API.
147+
141148
## FAQ
142149

143150
See the [Frequently Asked Questions](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/faq.html) page in the official documentation.

0 commit comments

Comments
 (0)