Merge topic 'doc-improvements'

8c77a3d3 docs: add a note about versioning
ebef8a5f

 docs: fix some nits

Acked-by: Kitware Robot <kwrobot@kitware.com>
Reviewed-by: Brad King <brad.king@kitware.com>
Merge-request: !78

README.md

@@ -5,14 +5,14 @@ all API endpoints are implemented, but patches are welcome.
 
 The API is based off of the 8.16.0 API and will likely aggressively track new
 API additions, so the newest release may not support talking to older releases
-where fields have been added..
+where fields have been added.
 
-All API types should be implemented in the [types](src/types.rs.in) module.
-These types should generally be implemented based on the `lib/api/entities.rb`
+All API types should be implemented in the [types](src/types.rs) module. These
+types should generally be implemented based on the `lib/api/entities.rb`
 module in the Gitlab repository. However, in the interest of usability,
 entities may be combined using `Option` to handle the differences. Generally,
-this should be done where the difference is "small". As a concrete example, the
-`Project` entity has dozens of fields and `ProjectWithAccess` has one
+this should be done where the difference is "small". As a concrete example,
+the `Project` entity has dozens of fields and `ProjectWithAccess` has one
 additional field (`permissions`) which is added using `Option` rather than
 creating a new `ProjectWithAccess` structure which only differs in this field.
 
@@ -23,6 +23,23 @@ If you run into places where Gitlab dumps a JSON value rather than an actual
 entity, please consider updating upstream to use a real entity so that changes
 to the structure are easier to track.
 
+# Versioning
+
+Since this crate follows Gitlab upstream, semantic versioning may not be
+possible. Instead, the crate uses the following versioning scheme:
+
+  * Gitlab 8.16 support → 0.816.x
+  * Gitlab 8.17 support → 0.817.x
+  * Gitlab 9.0 support → 0.900.x
+
+Minor versions may fix bugs, add API endpoint bindings, or improve webhook
+coverage. It is recommended to depend on the full version of the crate since
+types may change in patch-level updates in order to match Gitlab's interface:
+
+```toml
+gitlab = "0.816.0"
+```
+
 # API bugs
 
 Sometimes, the API will return `null` for fields that have been added after the