Update README.md

[TheTedder]

Description

This PR adds more info to the README, including a brief description of how to use the library.

---

• I have read and accept asl-help's license.

[just-ero]

Please add empty lines before any new heading. Typo-fixing requests apply to the entire document.

[just-ero]

This way of creating pointers is discouraged. The user should be using the MonoHelper overloads for making pointers. If their game is IL2CPP'd, they should be encouraged to store the class in a local.

mono.Make<T>("ClassName", "StaticFieldName", "InstanceField", "NextField", ...);

var c = mono["ClassName"]; // mono["Assembly", "ClassName"];

mono.Make<T>(c, "StaticFieldName", "InstanceField", "NextField", ...);

// on IL2CPP
var d = mono["DlassName"];
c.Make<T>("StaticFieldName", "InstanceField", d["NextField"], ...);

Please apply this information to the explanations below, as well as the Inheritance heading.

[TheTedder]

Why does storing it in a local matter for il2cpp? I believe you that it does but I am just curious as to why that would make a difference.

[TheTedder]

Also how do you specify inheritance without using the syntax that I put down?

[just-ero]

Why does storing it in a local matter for il2cpp?

So that you don't attempt to query the classes every time you need them (it will be cached, but you still have to check the cache unnecessarily when you already queried it once), and to reduce on code length and increase readability.

You can write

var c = mono["CClass"];
var d = mono["DClass"];
var e = mono["EClass"];
var f = mono["FClass"];

vars.Helper["Value"] = c.Make<T>("StaticField", "InstanceField", d["dField"], e["eField"], f["fField"]);

as

vars.Helper["Value"] = mono["CClass"].Make<T>("StaticField", "InstanceField", mono["DClass"]["dField"], mono["EClass"]["eField"], mono["FClass"]["fField"]);

but that just becomes unwieldy.

[just-ero]

Also how do you specify inheritance without using the syntax that I put down?

vars.Helper["Value"] = mono.Make<T>("ClassName", 1, "StaticField", "InstanceField", "NextField", ...);

or

var c = mono["CClass", 1];

vars.Helper["Value"] = mono.Make<T>(c, "StaticField", "InstanceField", "NextField", ...);