(statiqdevGH-301) Added additional information to Cake Alias

gep13 · May 29, 2016 · ad7f3a8 · ad7f3a8
1 parent c4b57f3
commit ad7f3a8
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/Cake.Wyam/WyamAliases.cs b/src/Cake.Wyam/WyamAliases.cs
@@ -5,7 +5,14 @@
 namespace Cake.Wyam
 {
     /// <summary>
-    /// Contains functionality for working with Wyam.
+    /// <para>Contains functionality related to <see href="https://github.com/Wyamio/Wyam">Wyam</see>.</para>
+    /// <para>
+    /// In order to use the commands for this alias, include the following in your build.cake file to download and install from NuGet.org, or specify the ToolPath within the WyamSettings class:
+    /// <code>
+    /// #addin "nuget:?package=Cake.Wyam"
+    /// #tool "nuget:?package=Wyam"
+    /// </code>
+    /// </para>
     /// </summary>
     [CakeAliasCategory("Wyam")]
     public static class WyamAliases