diff --git a/README.md b/README.md index 719dbec..9783dca 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,26 @@ Package **strfs** provides a virtual file-system, whre a `fs.File` can be create Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-strfs [![GoDoc](https://godoc.org/github.com/reiver/go-strfs?status.svg)](https://godoc.org/github.com/reiver/go-strfs) + +## Example fs.File + +Here is an example of turning a Go `string` into a `fs.File`: + +```go +import "github.com/reiver/go-strfs" + +// ... + +var s string = ""+"\n"+"Hello world!" + +var content strfs.Content = strfs.CreateContent(s) + +var regularfile strfs.RegularFile = strfs.RegularFile{ + FileContent: content, + FileName: "helloworld.html", + FileModTIme: time.Date(2022, 12, 12, 10, 30, 14, 2, time.UTC), +} + +var file fs.FS = ®ularfile + +```