From 01f8c01be252fc8ad646b55d03faf84a9dd9b8ad Mon Sep 17 00:00:00 2001 From: seguler Date: Wed, 15 Nov 2017 13:47:28 -0500 Subject: [PATCH 1/5] Readme updates --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ea4d7d..fc7d63c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ +# Azure Storage Blob SDK for Go +The Microsoft Azure Storage SDK for Go allows you to build applications that takes advantage of Azure's scalable cloud storage. -# Contributing +This repository contains the open source Blob SDK for Go. Documentation and examples can be found [here](https://godoc.org/github.com/Azure/azure-storage-blob-go/2016-05-31/azblob). +## Features +* Blob Storage + * Create/Read/Update/Delete Block Blobs + * Create/Read/Update/Delete Page Blobs + * Create/Read/Update/Delete Append Blobs + +## Getting Started +* If you don't already have it, install [the Go Programming runtime](https://golang.org/dl/) +* Go get the SDK: + + ```go get -u https://github.com/Azure/azure-storage-blob-go``` + +## SDK Architecture + +* Storage SDK for GO provides 2 set of APIs: high-level, and low-level APIs + * ServiceURI, ContainerURI and BlobURI objects provide the low-level API functionality and maps one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) + * A set of high-level APIs are provided in highlevel.go file. These functions provide high level abstractions for convenience like uploading a large stream to Blob storage using multiple PutBlock requests + +## Code Samples +* [Blob Storage Samples](https://github.com/seguler/azure-storage-blob-go/blob/master/2016-05-31/azblob/zt_examples_test.go) + +## License +This project is licensed under MIT. + +## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. @@ -11,4 +38,4 @@ provided by the bot. You will only need to do this once across all repos using o This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. From 6f29b10ef145f93011bbb75f978a2d6654a73747 Mon Sep 17 00:00:00 2001 From: "Sercan Guler [MSFT]" Date: Wed, 15 Nov 2017 10:53:55 -0800 Subject: [PATCH 2/5] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fc7d63c..5e242a0 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ This repository contains the open source Blob SDK for Go. Documentation and exam ## Features * Blob Storage - * Create/Read/Update/Delete Block Blobs - * Create/Read/Update/Delete Page Blobs - * Create/Read/Update/Delete Append Blobs + * Create/Read/Update/Delete Block Blobs + * Create/Read/Update/Delete Page Blobs + * Create/Read/Update/Delete Append Blobs ## Getting Started * If you don't already have it, install [the Go Programming runtime](https://golang.org/dl/) @@ -17,7 +17,7 @@ This repository contains the open source Blob SDK for Go. Documentation and exam ## SDK Architecture -* Storage SDK for GO provides 2 set of APIs: high-level, and low-level APIs +* Storage SDK for Go provides 2 set of APIs: high-level, and low-level APIs * ServiceURI, ContainerURI and BlobURI objects provide the low-level API functionality and maps one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) * A set of high-level APIs are provided in highlevel.go file. These functions provide high level abstractions for convenience like uploading a large stream to Blob storage using multiple PutBlock requests From bb05a0a7cca56e668d998b77144fb4050dfef8ba Mon Sep 17 00:00:00 2001 From: "Sercan Guler [MSFT]" Date: Wed, 15 Nov 2017 10:55:09 -0800 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e242a0..64702e8 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This repository contains the open source Blob SDK for Go. Documentation and exam * If you don't already have it, install [the Go Programming runtime](https://golang.org/dl/) * Go get the SDK: - ```go get -u https://github.com/Azure/azure-storage-blob-go``` +```go get -u https://github.com/Azure/azure-storage-blob-go``` ## SDK Architecture From 4cdd1ed1ae606df9ee85e333b98b0a3f151896a7 Mon Sep 17 00:00:00 2001 From: "Sercan Guler [MSFT]" Date: Wed, 15 Nov 2017 14:22:53 -0800 Subject: [PATCH 4/5] Fixing comments in Readme --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 64702e8..e8851a7 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,25 @@ This repository contains the open source Blob SDK for Go. Documentation and exam ## Features * Blob Storage - * Create/Read/Update/Delete Block Blobs - * Create/Read/Update/Delete Page Blobs - * Create/Read/Update/Delete Append Blobs + * Create/Delete/List Containers + * Create/Read/List/Update/Delete Block Blobs + * Create/Read/List/Update/Delete Page Blobs + * Create/Read/List/Update/Delete Append Blobs ## Getting Started -* If you don't already have it, install [the Go Programming runtime](https://golang.org/dl/) +* If you don't already have it, install [the Go distribution](https://golang.org/dl/) * Go get the SDK: -```go get -u https://github.com/Azure/azure-storage-blob-go``` +```go get github.com/Azure/azure-storage-blob-go/2016-05-31/azblob``` ## SDK Architecture -* Storage SDK for Go provides 2 set of APIs: high-level, and low-level APIs +* The Azure Storage SDK for Go provides low-level and high-level APIs. * ServiceURI, ContainerURI and BlobURI objects provide the low-level API functionality and maps one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) - * A set of high-level APIs are provided in highlevel.go file. These functions provide high level abstractions for convenience like uploading a large stream to Blob storage using multiple PutBlock requests + * The high-level APIs provide high-level convenience abstractions such as uploading a large stream to a block blob (using multiple PutBlock requests). ## Code Samples -* [Blob Storage Samples](https://github.com/seguler/azure-storage-blob-go/blob/master/2016-05-31/azblob/zt_examples_test.go) +* [Blob Storage Samples](https://godoc.org/github.com/Azure/azure-storage-blob-go/2016-05-31/azblob#pkg-examples) ## License This project is licensed under MIT. From 1978caa8174d303a3f1344561c966d0fe5b7f206 Mon Sep 17 00:00:00 2001 From: "Sercan Guler [MSFT]" Date: Wed, 15 Nov 2017 14:46:59 -0800 Subject: [PATCH 5/5] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e8851a7..d447150 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository contains the open source Blob SDK for Go. Documentation and exam ## Features * Blob Storage - * Create/Delete/List Containers + * Create/List/Delete Containers * Create/Read/List/Update/Delete Block Blobs * Create/Read/List/Update/Delete Page Blobs * Create/Read/List/Update/Delete Append Blobs @@ -19,11 +19,11 @@ This repository contains the open source Blob SDK for Go. Documentation and exam ## SDK Architecture * The Azure Storage SDK for Go provides low-level and high-level APIs. - * ServiceURI, ContainerURI and BlobURI objects provide the low-level API functionality and maps one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) - * The high-level APIs provide high-level convenience abstractions such as uploading a large stream to a block blob (using multiple PutBlock requests). + * ServiceURL, ContainerURL and BlobURL objects provide the low-level API functionality and map one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) + * The high-level APIs provide convenience abstractions such as uploading a large stream to a block blob (using multiple PutBlock requests). ## Code Samples -* [Blob Storage Samples](https://godoc.org/github.com/Azure/azure-storage-blob-go/2016-05-31/azblob#pkg-examples) +* [Blob Storage Examples](https://godoc.org/github.com/Azure/azure-storage-blob-go/2016-05-31/azblob#pkg-examples) ## License This project is licensed under MIT.