root
/
vfscopy
mirror of https://github.com/therootcompany/vfscopy
1
0
Fork 0
Code Issues Releases Wiki Activity

add LICENSE, AUTHORS, update README

This commit is contained in:
AJ ONeal 2020-10-23 15:30:03 -06:00
parent 9dcf11d07a
commit 93990f5db8
3 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AUTHORS Normal file
View File

@ -0,0 +1 @@
AJ ONeal <aj@therootcompany.com> (https://therootcompany.com)

22
LICENSE Normal file
View File

@ -0,0 +1,22 @@
The MIT License (MIT)
Copyright (c) 2020 The vfscopy Authors
Copyright (c) 2018 otiai10
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

14
README.md
View File

@ -4,6 +4,9 @@ Copy a Virtual FileSystem, such as
[http.FileSystem](https://golang.org/pkg/net/http/#FileSystem), [http.FileSystem](https://golang.org/pkg/net/http/#FileSystem),
recursively to a native file system destination. recursively to a native file system destination.
Works with any file system that implements http.FileSystem,
such as `vfsgen`, `fileb0x`, `gobindata`.
```go ```go
httpfs := http.Dir("/tmp/public/") httpfs := http.Dir("/tmp/public/")
vfs := vfscopy.NewVFS(httpfs) vfs := vfscopy.NewVFS(httpfs)
@ -16,6 +19,17 @@ if err := Copy(vfs, ".", "/tmp/dst/"); nil != err {
## Test ## Test
```bash ```bash
# Generate the test virtual file system
go generate ./... go generate ./...
# Run the tests
go test ./... go test ./...
``` ```
# License
The MIT License (MIT)
We used the recursive native file system copy implementation at
https://github.com/otiai10/copy as a starting point and added
virtual file system support.