From 8eb0733d6f8bce371cff040d8cbaa6062e13235a Mon Sep 17 00:00:00 2001
From: Stef Heyenrath <stef.heyenrath@gmail.com>
Date: Tue, 3 Aug 2021 06:01:40 +0000
Subject: [PATCH] update readme

---
 README.md                                     | 153 ++++++++++--------
 src-examples/ProxyInterfaceConsumer/Person.cs |   5 +
 .../ProxyInterfaceConsumer/Program.cs         |   1 +
 3 files changed, 90 insertions(+), 69 deletions(-)

diff --git a/README.md b/README.md
index 2b70eee..ea1cd07 100644
--- a/README.md
+++ b/README.md
@@ -1,69 +1,84 @@
-# ProxyInterfaceGenerator
-
-This project uses Source Generation to generate an interface and a Proxy class for classes.
-This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use DI.
-
-## Install
-[![NuGet Badge](https://buildstats.info/nuget/ProxyInterfaceGenerator)](https://www.nuget.org/packages/ProxyInterfaceGenerator)
-
-You can install from NuGet using the following command in the package manager window:
-
-`Install-Package ProxyInterfaceGenerator`
-
-Or via the Visual Studio NuGet package manager or if you use the `dotnet` command:
-
-`dotnet add package ProxyInterfaceGenerator`
-
-## Usage
-
-### Given: an external existing class which does not implement an interface
-``` c#
-public sealed class Person
-{
-    public string Name { get; set; }
-}
-```
-
-### Create a partial interface
-And annotate this with `ProxyInterfaceGenerator.Proxy[...]` and with the Type which needs to be wrapped:
-
-``` c#
-[ProxyInterfaceGenerator.Proxy(typeof(ProxyInterfaceConsumer.Person))]
-public partial interface IPerson
-{
-}
-```
-
-### When the code is compiled, this source generator creates the following
-
-#### :one: An additional partial interface
-Which defines the same properties and methods as in the external class.
-``` c#
-public partial interface IPerson
-{
-    string Name { get; set; }
-}
-```
-
-#### :two: A Proxy class
-Which takes the external class in the constructor and wraps all properties and methods.
-
-``` c#
-public class PersonProxy : IPerson
-{
-    public Person _Instance { get; }
-
-    public PersonProxy(Person instance)
-    {
-        _Instance = instance;
-    }
-
-    public string Name { get => _Instance.Name; set => _Instance.Name = value; }
-}
-```
-
-### Use it
-``` c#
-IPerson p = new PersonProxy(new Person());
-p.Name = "test";
-```
+# ProxyInterfaceGenerator
+
+This project uses Source Generation to generate an interface and a Proxy class for classes.
+This makes it possible to wrap external classes which do not have an interface, in a Proxy class which makes it easier to Mock and use DI.
+
+## Install
+[![NuGet Badge](https://buildstats.info/nuget/ProxyInterfaceGenerator)](https://www.nuget.org/packages/ProxyInterfaceGenerator)
+
+You can install from NuGet using the following command in the package manager window:
+
+`Install-Package ProxyInterfaceGenerator`
+
+Or via the Visual Studio NuGet package manager or if you use the `dotnet` command:
+
+`dotnet add package ProxyInterfaceGenerator`
+
+## Usage
+
+### Given: an external existing class which does not implement an interface
+``` c#
+public sealed class Person
+{
+    public string Name { get; set; }
+
+    public string HelloWorld(string name)
+    {
+        return $"Hello {name} !";
+    }
+}
+```
+
+### Create a partial interface
+And annotate this with `ProxyInterfaceGenerator.Proxy[...]` and with the Type which needs to be wrapped:
+
+``` c#
+[ProxyInterfaceGenerator.Proxy(typeof(ProxyInterfaceConsumer.Person))]
+public partial interface IPerson
+{
+}
+```
+
+### When the code is compiled, this source generator creates the following
+
+#### :one: An additional partial interface
+Which defines the same properties and methods as in the external class.
+``` c#
+public partial interface IPerson
+{
+    string Name { get; set; }
+
+    string HelloWorld(string name);
+}
+```
+
+#### :two: A Proxy class
+Which takes the external class in the constructor and wraps all properties and methods.
+
+``` c#
+public class PersonProxy : IPerson
+{
+    public Person _Instance { get; }
+
+    public PersonProxy(Person instance)
+    {
+        _Instance = instance;
+    }
+
+    public string Name { get => _Instance.Name; set => _Instance.Name = value; }
+
+    public string HelloWorld(string name)
+    {
+        string name_ = name;
+        var result_19479959 = _Instance.HelloWorld(name_);
+        return result_19479959;
+    }
+}
+```
+
+### Use it
+``` c#
+IPerson p = new PersonProxy(new Person());
+p.Name = "test";
+p.HelloWorld("stef");
+```
diff --git a/src-examples/ProxyInterfaceConsumer/Person.cs b/src-examples/ProxyInterfaceConsumer/Person.cs
index 09c0e34..aa7bdb2 100644
--- a/src-examples/ProxyInterfaceConsumer/Person.cs
+++ b/src-examples/ProxyInterfaceConsumer/Person.cs
@@ -45,6 +45,11 @@ namespace ProxyInterfaceConsumer
             return s + @string;
         }
 
+        public string HelloWorld(string name)
+        {
+            return $"Hello {name} !";
+        }
+
         public void AddWithParams(params string[] values)
         {
         }
diff --git a/src-examples/ProxyInterfaceConsumer/Program.cs b/src-examples/ProxyInterfaceConsumer/Program.cs
index 674e1f3..9afbd2f 100644
--- a/src-examples/ProxyInterfaceConsumer/Program.cs
+++ b/src-examples/ProxyInterfaceConsumer/Program.cs
@@ -27,6 +27,7 @@ namespace ProxyInterfaceConsumer
 
             IPerson p = new PersonProxy(new Person());
             p.Name = "test";
+            p.HelloWorld("stef");
             Console.WriteLine("DefaultValue " + p.DefaultValue());
             Console.WriteLine("DefaultValue " + p.DefaultValue(42));