Commit daaa0cfa authored by Han-Wen Nienhuys's avatar Han-Wen Nienhuys

README.md: tweak & polish

Change-Id: Ide68c48ffc2b8343884639835b958bf404739dbc
parent d537a5a8
# GO-FUSE # Go-FUSE
[![CI](https://github.com/hanwen/go-fuse/actions/workflows/ci.yml/badge.svg)](https://github.com/hanwen/go-fuse/actions/workflows/ci.yml) [![CI](https://github.com/hanwen/go-fuse/actions/workflows/ci.yml/badge.svg)](https://github.com/hanwen/go-fuse/actions/workflows/ci.yml)
[![GoDoc](https://godoc.org/github.com/hanwen/go-fuse?status.svg)](https://godoc.org/github.com/hanwen/go-fuse/v2) [![GoDoc](https://godoc.org/github.com/hanwen/go-fuse/v2/fs?status.svg)](https://godoc.org/github.com/hanwen/go-fuse/v2/fs)
Go native bindings for the FUSE kernel module. Go native bindings for the FUSE kernel module.
...@@ -20,7 +20,7 @@ and ...@@ -20,7 +20,7 @@ and
The FUSE library gained a new, cleaned-up API during a rewrite The FUSE library gained a new, cleaned-up API during a rewrite
completed in 2019. Find extensive documentation completed in 2019. Find extensive documentation
[here](https://godoc.org/github.com/hanwen/go-fuse/v2). [here](https://godoc.org/github.com/hanwen/go-fuse/v2/fs).
Further highlights of this library is Further highlights of this library is
...@@ -31,9 +31,9 @@ Further highlights of this library is ...@@ -31,9 +31,9 @@ Further highlights of this library is
## Examples ## Examples
* `example/hello/main.go` contains a 60-line "hello world" filesystem * [example/hello/](example/hello/main.go) contains a 60-line "hello world" filesystem
* `zipfs/zipfs.go` contains a small and simple read-only filesystem for * [zipfs/zipfs](zipfs/zipfs.go) contains a small and simple read-only filesystem for
zip and tar files. The corresponding command is in example/zipfs/ zip and tar files. The corresponding command is in example/zipfs/
For example, For example,
...@@ -44,10 +44,10 @@ Further highlights of this library is ...@@ -44,10 +44,10 @@ Further highlights of this library is
fusermount -u /tmp/mountpoint fusermount -u /tmp/mountpoint
```` ````
* `zipfs/multizipfs.go` shows how to use in-process mounts to * [zipfs/multizipfs](zipfs/multizipfs.go) shows how to use combine
combine multiple Go-FUSE filesystems into a larger filesystem. simple Go-FUSE filesystems into a larger filesystem.
* `fuse/loopback.go` mounts another piece of the filesystem. * [example/loopback](example/loopback/main.go) mounts another piece of the filesystem.
Functionally, it is similar to a symlink. A binary to run is in Functionally, it is similar to a symlink. A binary to run is in
example/loopback/ . For example example/loopback/ . For example
...@@ -60,7 +60,7 @@ Further highlights of this library is ...@@ -60,7 +60,7 @@ Further highlights of this library is
## macOS Support ## macOS Support
go-fuse works somewhat on OSX. Known limitations: Go-FUSE works somewhat on OSX. Known limitations:
* All of the limitations of OSXFUSE, including lack of support for * All of the limitations of OSXFUSE, including lack of support for
NOTIFY. NOTIFY.
...@@ -82,18 +82,13 @@ go-fuse works somewhat on OSX. Known limitations: ...@@ -82,18 +82,13 @@ go-fuse works somewhat on OSX. Known limitations:
## Bugs ## Bugs
Yes, probably. Report them through Yes, probably. Report them through
https://github.com/hanwen/go-fuse/issues https://github.com/hanwen/go-fuse/issues. Please include a debug trace
(set `fuse.MountOptions.Debug` to `true`).
## Disclaimer ## Disclaimer
This is not an official Google product. This is not an official Google product.
## Known Problems
Grep source code for TODO. Major topics:
* Missing support for `CUSE`, `BMAP`, `IOCTL`
## License ## License
Like Go, this library is distributed under the new BSD license. See Like Go, this library is distributed under the new BSD license. See
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment