[Docs] Added doc with instructions for how to use snapshot versions of the library

dsn5ft · melaniegoetz · commit d103997bbe7d · 2020-06-17T18:09:12.000-07:00
PiperOrigin-RevId: 316700593
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ Bugs or feature requests should be submitted at our [GitHub Issues section](http
 - [All Components](https://github.com/material-components/material-components-android/tree/master/lib/)
 - [Getting Started](docs/getting-started.md)
 - [Contributing](docs/contributing.md)
+- [Using Snapshot Version](using-snapshot-version.md)
 - [Building From Source](docs/building-from-source.md)
 - [Catalog App](docs/catalog-app.md)
 - [Class
diff --git a/docs/building-from-source.md b/docs/building-from-source.md
@@ -38,14 +38,13 @@ Note: Do not update Gradle beyond 4.10 as the
 dependency cannot be used for Gradle 5.x.
 
 ## Useful Links
-- [Getting Started](getting-started.md)
-- [Contributing](contributing.md)
-- [Catalog App](catalog-app.md)
-- [Class
-  documentation](https://developer.android.com/reference/com/google/android/material/classes)
-- [MDC-Android on Stack
-  Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
-- [Android Developer’s
-  Guide](https://developer.android.com/training/material/index.html)
-- [Material.io](https://www.material.io)
-- [Material Design Guidelines](https://material.google.com)
+
+-   [Getting Started](getting-started.md)
+-   [Contributing](contributing.md)
+-   [Catalog App](catalog-app.md)
+-   [Using Snapshot Version](using-snapshot-version.md)
+-   [Class documentation](https://developer.android.com/reference/com/google/android/material/classes)
+-   [MDC-Android on Stack Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
+-   [Android Developer’s Guide](https://developer.android.com/training/material/index.html)
+-   [Material.io](https://www.material.io)
+-   [Material Design Guidelines](https://material.google.com)
diff --git a/docs/catalog-app.md b/docs/catalog-app.md
@@ -20,15 +20,14 @@ Android Studio or run the following Gradle command:
 ```
 
 ## Useful Links
-- [Getting Started](getting-started.md)
-- [Theming Guide](theming.md)
-- [Contributing](contributing.md)
-- [Building From Source](building-from-source.md)
-- [Class
-  documentation](https://developer.android.com/reference/com/google/android/material/classes)
-- [MDC-Android on Stack
-  Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
-- [Android Developer’s
-  Guide](https://developer.android.com/training/material/index.html)
-- [Material.io](https://www.material.io)
-- [Material Design Guidelines](https://material.google.com)
+
+-   [Getting Started](getting-started.md)
+-   [Theming Guide](theming.md)
+-   [Contributing](contributing.md)
+-   [Using Snapshot Version](using-snapshot-version.md)
+-   [Building From Source](building-from-source.md)
+-   [Class documentation](https://developer.android.com/reference/com/google/android/material/classes)
+-   [MDC-Android on Stack Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
+-   [Android Developer’s Guide](https://developer.android.com/training/material/index.html)
+-   [Material.io](https://www.material.io)
+-   [Material Design Guidelines](https://material.google.com)
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -85,6 +85,7 @@ We follow the
 ## Useful Links
 
 -   [Getting Started](getting-started.md)
+-   [Using Snapshot Version](using-snapshot-version.md)
 -   [Building From Source](building-from-source.md)
 -   [Catalog App](catalog-app.md)
 -   [Class documentation](https://developer.android.com/reference/com/google/android/material/classes)
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -249,6 +249,7 @@ out our [contributing guidelines](contributing.md) as well as an overview of the
 
 -   [Theming Guide](theming.md)
 -   [Contributing](contributing.md)
+-   [Using Snapshot Version](using-snapshot-version.md)
 -   [Building From Source](building-from-source.md)
 -   [Catalog App](catalog-app.md)
 -   [Class documentation](https://developer.android.com/reference/com/google/android/material/classes)
diff --git a/docs/theming.md b/docs/theming.md
@@ -30,15 +30,14 @@ information on how to apply the
 to your app.
 
 ## Useful Links
-- [Getting Started](getting-started.md)
-- [Contributing](contributing.md)
-- [Building From Source](building-from-source.md)
-- [Catalog App](catalog-app.md)
-- [Class
-  documentation](https://developer.android.com/reference/com/google/android/material/classes)
-- [MDC-Android on Stack
-  Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
-- [Android Developer’s
-  Guide](https://developer.android.com/training/material/index.html)
-- [Material.io](https://www.material.io)
-- [Material Design Guidelines](https://material.google.com)
+
+-   [Getting Started](getting-started.md)
+-   [Contributing](contributing.md)
+-   [Using Snapshot Version](using-snapshot-version.md)
+-   [Building From Source](building-from-source.md)
+-   [Catalog App](catalog-app.md)
+-   [Class documentation](https://developer.android.com/reference/com/google/android/material/classes)
+-   [MDC-Android on Stack Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
+-   [Android Developer’s Guide](https://developer.android.com/training/material/index.html)
+-   [Material.io](https://www.material.io)
+-   [Material Design Guidelines](https://material.google.com)
diff --git a/docs/using-snapshot-build.md b/docs/using-snapshot-build.md
@@ -0,0 +1,54 @@
+<!--docs:
+title: "Using Snapshot Version"
+layout: landing
+section: docs
+path: /docs/using-snapshot-version/
+-->
+
+# Using a Snapshot Version of the Library
+
+If you would like to depend on the cutting edge version of the MDC-Android
+library, you can use the
+[snapshot versions](https://github.com/material-components/material-components-android/packages/81484)
+that are published daily via
+[GitHub Packages](https://help.github.com/en/packages/publishing-and-managing-packages/about-github-packages).
+
+To do so, you need to
+[create a GitHub access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token),
+and add the following to your `build.gradle` Maven repositories:
+
+```groovy
+maven {
+    name = "MaterialSnapshots"
+    url = uri("https://maven.pkg.github.com/material-components/material-components-android")
+    credentials {
+        username = <github_username>
+        password = <github_access_token>
+    }
+}
+```
+
+Then you can use a snapshot version by adding a
+`com.google.android.material:material:1.3.0-dev-<date>` dependency as per usual,
+replacing `<date>` with the date of the version you are interested in (see all
+versions
+[here](https://github.com/material-components/material-components-android/packages/81484/versions)).
+See the offical doc on
+[Configuring Gradle for use with GitHub Packages](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-gradle-for-use-with-github-packages)
+for additional information.
+
+Alternatively, you could use
+[JitPack](https://jitpack.io/#material-components/material-components-android)
+to generate library releases based on specific commits.
+
+## Useful Links
+
+-   [Getting Started](getting-started.md)
+-   [Contributing](contributing.md)
+-   [Building From Source](building-from-source.md)
+-   [Catalog App](catalog-app.md)
+-   [Class documentation](https://developer.android.com/reference/com/google/android/material/classes)
+-   [MDC-Android on Stack Overflow](https://www.stackoverflow.com/questions/tagged/material-components+android)
+-   [Android Developer’s Guide](https://developer.android.com/training/material/index.html)
+-   [Material.io](https://www.material.io)
+-   [Material Design Guidelines](https://material.google.com)
