mirror of
https://github.com/jkaninda/go-storage.git
synced 2025-12-06 16:49:39 +01:00
docs: update readme
This commit is contained in:
62
README.md
62
README.md
@@ -1,11 +1,11 @@
|
||||
# Go Storage
|
||||
|
||||
A simple Go storage client
|
||||
Supported storage:
|
||||
- Local
|
||||
- S3
|
||||
- SSH
|
||||
- FTP
|
||||
|
||||
|
||||
```go
|
||||
go get github.com/jkaninda/go-storage
|
||||
```
|
||||
@@ -36,10 +36,64 @@ s3Storage, err := s3.NewStorage(s3.Config{
|
||||
LocalPath: "",
|
||||
})
|
||||
if err != nil {
|
||||
utils.Fatal("Error creating s3 storage: %s", err)
|
||||
log.Fatalf("Error creating s3 storage: %s", err)
|
||||
}
|
||||
// Copy file to S3
|
||||
err = s3Storage.Copy(finalFileName)
|
||||
if err != nil {
|
||||
utils.Fatal("Error copying file, error %v", err)
|
||||
log.Fatalf("Error copying file, error %v", err)
|
||||
}
|
||||
// Download file from S3
|
||||
err = s3Storage.CopyFrom(finalFileName)
|
||||
if err != nil {
|
||||
log.Fatalf("Error copying file, error %v", err)
|
||||
}
|
||||
```
|
||||
|
||||
### SSH Storage
|
||||
```go
|
||||
sshStorage, err := ssh.NewStorage(ssh.Config{
|
||||
Host: "",
|
||||
Port: "",
|
||||
User: "",
|
||||
Password: "",
|
||||
RemotePath: "",
|
||||
LocalPath: "",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatalf("Error creating SSH storage: %s", err)
|
||||
}
|
||||
// Copy file to the remote server
|
||||
err = sshStorage.Copy(finalFileName)
|
||||
if err != nil {
|
||||
log.Fatalf("Error copying backup file: %s", err)
|
||||
}
|
||||
// Download file from SSH remote server
|
||||
err = sshStorage.CopyFrom(finalFileName)
|
||||
if err != nil {
|
||||
log.Fatalf("Error copying file, error %v", err)
|
||||
}
|
||||
```
|
||||
### FTP Storage
|
||||
```go
|
||||
ftpStorage, err := ftp.NewStorage(ftp.Config{
|
||||
Host: "",
|
||||
Port: "",
|
||||
User: "",
|
||||
Password: "",
|
||||
RemotePath: "",
|
||||
LocalPath: "",
|
||||
})
|
||||
if err != nil {
|
||||
log.Fatalf("Error creating FTP storage: %s", err)
|
||||
}
|
||||
err = ftpStorage.Copy(finalFileName)
|
||||
if err != nil {
|
||||
log.Fatalf("Error copying backup file: %s", err)
|
||||
}
|
||||
// Download file from ftp remote server
|
||||
err = ftpStorage.CopyFrom(finalFileName)
|
||||
if err != nil {
|
||||
log.Fatalf("Error copying file, error %v", err)
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user