Document the new set of modules

Author: emlun

README

@@ -36,6 +36,32 @@ Gradle:
 compile 'com.yubico:webauthn-server-core:1.7.0'
 ----------
 
+=== Semantic versioning
+
+This library uses link:https://semver.org/[semantic versioning].
+The public API consists of all public classes, methods and fields in the `com.yubico.webauthn` package and its subpackages,
+i.e., everything covered by the
+link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/package-summary.html[Javadoc].
+
+Package-private classes and methods are NOT part of the public API.
+The `com.yubico:yubico-util` module is NOT part of the public API.
+Breaking changes to these will NOT be reflected in version numbers.
+
+
+=== Additional modules
+
+In addition to the main `webauthn-server-core` module, there are also:
+
+- `webauthn-server-attestation`: A simple implementation of the
+  link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/attestation/MetadataService.html[`MetadataService`]
+  interface, which by default comes preloaded with attestation metadata for Yubico devices.
+
+- `webauthn-server-core-minimal`: Alternative distribution of `webauthn-server-core`,
+  without a dependency on BouncyCastle.
+  If depending on this module instead of `webauthn-server-core`,
+  you may have to add your own JCA providers to support some signature algorithms.
+  In particular, OpenJDK 14 and earlier does not include providers for the EdDSA family of algorithms.
+
 
 == Features
 

doc/development.md

@@ -0,0 +1,16 @@
+Developer docs
+===
+
+Inconsistent directory naming
+---
+
+In resolving [issue #97](https://github.com/Yubico/java-webauthn-server/issues/97),
+we opted to split the `webauthn-server-core` module into one `webauthn-server-core` meta-module
+and one `webauthn-server-core-minimal` module with the code and all dependencies except BouncyCastle.
+However, to avoid file renames and since this is intended as a temporary change,
+the source code for the `webauthn-server-core` module is hosted in the `webauthn-server-core-bundle/` subproject
+and the `webauthn-server-core-minimal` module is hosted in `webauthn-server-core/`.
+
+We intend to eliminate the `webauthn-server-core-bundle` subproject in the next major version release,
+and return the current `webauthn-server-core-minimal` module to the `webauthn-server-core` module name.
+This naming inconsistency should be fixed along with this.