Skip to content

Commit

Permalink
完善文档
Browse files Browse the repository at this point in the history
  • Loading branch information
deatil committed Dec 17, 2024
1 parent 731db6d commit 61fd5a3
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func main() {

// 写入数据
path := "/path.txt"
contents := []byte("")
contents := []byte("testdata")

ok, err := fs.Write(path, contents)
if err != nil {
Expand All @@ -52,49 +52,49 @@ func main() {

~~~go
// 写入
fs.Write(path, contents string) (bool, error)
Write(path, contents []byte) (bool, error)

// 写入数据流
fs.WriteStream(path string, resource io.Reader) (bool, error)
WriteStream(path string, resource io.Reader) (bool, error)

// 添加数据
fs.Put(path, contents string) (bool, error)
Put(path, contents []byte) (bool, error)

// 添加数据流
fs.PutStream(path string, resource io.Reader) (bool, error)
PutStream(path string, resource io.Reader) (bool, error)

// 读取后删除
fs.ReadAndDelete(path string) (any, error)
ReadAndDelete(path string) (any, error)

// 更新
fs.Update(path, contents string) (bool, error)
Update(path, contents []byte) (bool, error)

// 读取
fs.Read(path string) (string, error)
Read(path string) ([]byte, error)

// 重命名
fs.Rename(path, newpath string) (bool, error)
Rename(path, newpath string) (bool, error)

// 复制
fs.Copy(path, newpath string) (bool, error)
Copy(path, newpath string) (bool, error)

// 删除
fs.Delete(path string) (bool, error)
Delete(path string) (bool, error)

// 删除文件夹
fs.DeleteDir(dirname string) (bool, error)
DeleteDir(dirname string) (bool, error)

// 创建文件夹
fs.CreateDir(dirname string) (bool, error)
CreateDir(dirname string) (bool, error)

// 列出内容
fs.ListContents(dirname string) ([]map[string]any, error)
ListContents(dirname string) ([]map[string]any, error)
~~~


### 开源协议

* `go-filesystem` 文件管理器 遵循 `Apache2` 开源协议发布,在保留本软件版权的情况下提供个人及商业免费使用。
* `go-filesystem` 遵循 `Apache2` 开源协议发布,在保留本软件版权的情况下提供个人及商业免费使用。


### 版权
Expand Down

0 comments on commit 61fd5a3

Please sign in to comment.