Updated module name

Author: Lord of Scripts

.gitignore

@@ -0,0 +1,30 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+
+# Others
+bin/*
+TODO*
+*.bfproject

README.md

@@ -1,17 +1,58 @@
-vfs for golang [![Build Status](https://travis-ci.org/blang/vfs.svg?branch=master)](https://travis-ci.org/blang/vfs) [![GoDoc](https://godoc.org/github.com/3JoB/vfs?status.png)](https://godoc.org/github.com/3JoB/vfs) [![Coverage Status](https://img.shields.io/coveralls/blang/vfs.svg)](https://coveralls.io/r/blang/vfs?branch=master) [![Join the chat at https://gitter.im/blang/vfs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/blang/vfs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-======
+# VFS for GoLang
 
-vfs is library to support virtual filesystems. It provides basic abstractions of filesystems and implementations, like `OS` accessing the file system of the underlying OS and `memfs` a full filesystem in-memory.
+![Build](https://github.com/lordofscripts/vfs/actions/workflows/go.yml/badge.svg)
+[![Go Report Card](https://goreportcard.com/badge/github.com/lordofscripts/vfs?style=flat-square)](https://goreportcard.com/report/github.com/lordofscripts/vfs)
+[![Coverage](https://coveralls.io/repos/github/lordofscripts/vfs/badge.svg?branch=main)](https://coveralls.io/github/lordofscripts/vfs?branch=main)
+![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/lordofscripts/vfs)
+
+`vfs` is GO library to support *Virtual Filesystems*. It provides the basic
+abstractions of filesystems and implementations, like:
+
+* `OS` accessing the file system of the underlying OS,
+* `memfs` a full filesystem in-memory, and
+* `dummy` which does nothing other than outputting what file operation was
+  called without actually modifiying the underlying file system.
+
+## What's Different?
+
+You may have noticed this is a *forked* repository. I forked it from
+[3JoB/vfs](https://github.com/3JoB/vfs) which in turn is an improved fork of
+the original `blang/vfs` by [Benedikt Lang)](https://github.com/blang/vfs).
+
+I originally used BLang's version `v1.0.0`  and was satisfied with it, although I had
+to write some extra code to accomplish what I needed. I realized I needed
+BLang's **Dummy** File System but improved to meet my requirements. Unfortunately,
+after submitting several issues to the original repository, no answer came of
+it. In fact Benedikt's repository has not been updated in 9 years! But it is
+still quite useful in its simplicity!
+
+After testing my own shell object to emulate a Dummy Filesystem, I realized it
+was better to simply enhance his original `DummyFS`. That's how I came across
+**3JoB's** clone tagged `v1.0.0` which has some enhancements over Benedikt's version:
+
+* Support for Symbolic Links
+* Minor changes like using `any` instead of `interface{}`
+
+Therefore, I decided to build upon this one instead. After all, 3JoB's version
+was updated last year (2023).
+
+Is this a YAUF (Yet-Another-Useless-Fork)? well, no! I plan on making certain
+enhancements that would make it suitable for my application out-of-the-box
+without the need for glue structures. So, Keep tuned! But to start with:
+
+* Updated it to use `main` as branch instead of the deprecated `master`
+* Added `go.mod`
+* Included a GO workflow.
+
+## Usage
 
-Usage
------
 ```bash
-$ go get github.com/3JoB/vfs
+$ go get github.com/lordofscripts/vfs
 ```
 Note: Always vendor your dependencies or fix on a specific version tag.
 
 ```go
-import github.com/3JoB/vfs
+import github.com/lordofscripts/vfs
 ```
 
 ```go
@@ -54,8 +95,7 @@ fs.Mkdir("/tmp/testdir", 0777)
 
 Check detailed examples below. Also check the [GoDocs](http://godoc.org/github.com/3JoB/vfs).
 
-Why should I use this lib?
------
+## Why should I use this lib?
 
 - Only Stdlib
 - (Nearly) Fully tested (Coverage >90%)
@@ -64,33 +104,35 @@ Why should I use this lib?
 - Compose/Wrap Filesystems `ReadOnly(OS())` and write simple Wrappers
 - Many features, see [GoDocs](http://godoc.org/github.com/3JoB/vfs) and examples below
 
-Features and Examples
------
+## Features and Examples
 
 - [OS Filesystem support](http://godoc.org/github.com/3JoB/vfs#example-OsFS)
 - [ReadOnly Wrapper](http://godoc.org/github.com/3JoB/vfs#example-RoFS)
 - [DummyFS for quick mocking](http://godoc.org/github.com/3JoB/vfs#example-DummyFS)
 - [MemFS - full in-memory filesystem](http://godoc.org/github.com/3JoB/vfs/memfs#example-MemFS)
 - [MountFS - support mounts across filesystems](http://godoc.org/github.com/3JoB/vfs/mountfs#example-MountFS)
 
-Current state: ALPHA
------
+### Current state: BETA
 
-While the functionality is quite stable and heavily tested, interfaces are subject to change. 
+While the functionality is quite stable and heavily tested, interfaces are subject to change.
 
     You need more/less abstraction? Let me know by creating a Issue, thank you.
 
-Motivation
------
+### Motivation
+
+The original author [Benedikt Lang](https://github.com/blang) wrote:
+
+> I simply couldn't find any lib supporting this wide range of variation and adaptability.
+
+And I (*LordOfScripts*) share his thoughts. In fact, I evaluated several similar
+GO libraries but many were too bloated and included other appendages I was not
+interested in. I loved this VFS version because it had no other dependencies.
 
-I simply couldn't find any lib supporting this wide range of variation and adaptability.
 
-Contribution
------
+### Contribution
 
 Feel free to make a pull request. For bigger changes create a issue first to discuss about it.
 
-License
------
+### License
 
 See [LICENSE](LICENSE) file.

example_dummy_test.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/3JoB/vfs"
+	"github.com/lordofscripts/vfs"
 )
 
 type myFS struct {

example_os_test.go

@@ -3,7 +3,7 @@ package vfs_test
 import (
 	"fmt"
 
-	"github.com/3JoB/vfs"
+	"github.com/lordofscripts/vfs"
 )
 
 func ExampleOsFS() {

example_readonly_test.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/3JoB/vfs"
+	"github.com/lordofscripts/vfs"
 )
 
 // Every vfs.Filesystem could be easily wrapped

example_test.go

@@ -4,9 +4,9 @@ import (
 	"errors"
 	"os"
 
-	"github.com/3JoB/vfs"
-	"github.com/3JoB/vfs/memfs"
-	"github.com/3JoB/vfs/mountfs"
+	"github.com/lordofscripts/vfs"
+	"github.com/lordofscripts/vfs/memfs"
+	"github.com/lordofscripts/vfs/mountfs"
 )
 
 func Example() {

example_wrapping_test.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/3JoB/vfs"
+	"github.com/lordofscripts/vfs"
 )
 
 type noNewDirs struct {

go.mod

@@ -1,3 +1,3 @@
-module github.com/3JoB/vfs
+module github.com/lordofscripts/vfs
 
-go 1.20
+go 1.22.1

ioutil_test.go

@@ -5,8 +5,8 @@ import (
 	"os"
 	"testing"
 
-	"github.com/3JoB/vfs"
-	"github.com/3JoB/vfs/memfs"
+	"github.com/lordofscripts/vfs"
+	"github.com/lordofscripts/vfs/memfs"
 )
 
 var (

memfs/example_test.go

@@ -1,7 +1,7 @@
 package memfs_test
 
 import (
-	"github.com/3JoB/vfs/memfs"
+	"github.com/lordofscripts/vfs/memfs"
 )
 
 func ExampleMemFS() {