docs: Add missing docstrings

This commit is contained in:
Rohan Verma
2018-12-06 16:48:37 +05:30
parent f30c5f9052
commit 157aa88554
6 changed files with 48 additions and 31 deletions
+8 -9
View File
@@ -6,23 +6,23 @@ SimpleS3 is a golang library for uploading and deleting objects on S3 buckets us
## Install
```
```sh
go get github.com/rhnvrm/simples3
```
## Example
```
```go
testTxt, _ := os.Open("test.txt")
defer testTxt.Close()
s3 := simples3.New(Region, AWSAccessKey, AWSSecretKey)
err := s3.FileUpload(simples3.UploadInput{
Bucket: "zerodha-testbucket",
ObjectKey: "test.txt",
ContentType: "text/plain",
FileName: "test.txt",
Body: testTxt,
Bucket: "zerodha-testbucket",
ObjectKey: "test.txt",
ContentType: "text/plain",
FileName: "test.txt",
Body: testTxt,
}
```
@@ -40,5 +40,4 @@ ToDo.
## License
MIT.
MIT.