Readme + xmldocs in sample

Author: ArcadeMode

README.md

@@ -20,7 +20,10 @@ TypeShim generates strongly-typed interop code for both C# & TypeScript, tailore
 - 👍 [Easy setup](#installing)
 
 ## Samples
-Samples below demonstrate the same operations when interfacing with TypeShim generated code vs `JSExport` generated code. Either way you will load your wasm browser app as [described in the docs](https://learn.microsoft.com/en-us/aspnet/core/client-side/dotnet-interop/wasm-browser-app?view=aspnetcore-10.0#javascript-interop-on-). The runtime created by `dotnet.create()` can be passed directly into the provided `TypeShimInitializer`'s `initialize` method. The initializer exists so that helper functions for type marshalling can be set up and a reference to the assembly exports can be retrieved for the generated types to use internally.
+
+[Check out the sample project](https://github.com/ArcadeMode/TypeShim/blob/master/sample/README.md) to see TypeShim in action. The snippets below also give a general idea of its capabilities.
+
+The snippets compare TypeShim vs manual `JSExport`. Whichever you use, you'll have load your wasm browser app as [described in the docs](https://learn.microsoft.com/en-us/aspnet/core/client-side/dotnet-interop/wasm-browser-app?view=aspnetcore-10.0#javascript-interop-on-). The runtime created by `dotnet.create()` can be passed directly into the provided `TypeShimInitializer`'s `initialize` method. The initializer exists so that helper functions for type marshalling can be set up and a reference to the assembly exports can be retrieved for the generated types to use internally.
 
 ### TypeShim
 A simple example where we have an app about 'people', just to show basic language use powered by TypeShim.
@@ -95,14 +98,12 @@ public async UsingTypeShim() {
 ```
 
 #### 'Raw' JSExport
-Here you can see a quick demonstration of roughly the same behavior as the TypeShim sample, with handwritten JSExport. Certain parts enabled by TypeShim have not been replicated as the point may be clear at a glance: this is a large amount of difficult to maintain boilerplate if you have to write it yourself.
+Here you can see a quick demonstration of roughly the same behavior as the TypeShim sample, with handwritten JSExport. Certain parts enabled by TypeShim have not been replicated as the point may be clear at a glance: this is a large amount of difficult to maintain boilerplate if you have to write it yourself. The regression sensitivity of such code may also be noted.
 
 <details>
   <summary>See the 'Raw' <code>JSExport</code> implementation</summary>
 &nbsp;
 
-Note the error sensitivity of passing untyped objects across the interop boundary.
-
 ```ts
 public async UsingRawJSExport(exports: any) {
     const runtime = await dotnet.withApplicationArguments(args).create();

sample/Library/Models.cs

@@ -10,19 +10,46 @@ public class People()
     public required Person[] All { get; set; }
 }
 
+/// <summary>
+/// Represents a person with a unique identifier, name, age, and a collection of owned pets.
+/// </summary>
+/// <remarks>The Pets property contains an array of Dog objects that represent the pets currently owned by the
+/// person. The Person class provides methods to compare ages with another person and to adopt new pets.
+/// </remarks>
 [TSExport]
 public class Person
 {
+
+    // this class has a few comments,
+    // To demonstrate that these will reflect in the generated TypeScript code
+    // as documentation for the properties and methods of the Person class!
+
+    /// <summary>
+    /// Comments work <i>including formatting</i>
+    /// <list type="bullet">
+    /// <item><description>Even</description></item>
+    /// <item><description>Lists</description></item>
+    /// <item><description><b>Work!</b></description></item>
+    /// </list>
+    /// </summary>
     public required int Id { get; set; }
     public required string Name { get; set; }
     public required int Age { get; set; }
     public required Dog[] Pets { get; set; }
 
+    /// <summary>
+    /// Checks if this person is older than another person.
+    /// </summary>
+    /// <param name="other">Another person</param>
+    /// <returns>True if this person is older than the other person, otherwise false</returns>
     public bool IsOlderThan(Person other)
     {
         return Age > other.Age;
     }
 
+    /// <summary>
+    /// Adopts a <b>new pet</b> for this person.
+    /// </summary>
     public void AdoptPet()
     {
         RandomEntityGenerator generator = new();