diff --git a/README.md b/README.md index 00afede..4b1d10c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,19 @@ or by adding it as a reference using NuGet: Install-Package SharpPhysFS +You should also include compiled shared library of physfs alongside your binary files to be loaded. + +## Usage + +````c# +using(var pfs = new PhysFS("")) // This ensures correct initialization and deinitialization +using(var stream = pfs.OpenRead("/helloworld.txt")) +{ + var reader = new StreamReader(stream); + var contents = reader.ReadToEnd(); +} +```` + ## Support on Beerpay Hey dude! Help me out for a couple of :beers:!