diff --git a/README.md b/README.md index 3ae7284..00acab4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ -[![Build Status](https://api.cirrus-ci.com/github/cirruslabs/google-storage-proxy.svg)](https://cirrus-ci.com/github/cirruslabs/google-storage-proxy) [![](https://images.microbadger.com/badges/image/cirrusci/google-storage-proxy.svg)](https://microbadger.com/images/cirrusci/google-storage-proxy) +[![Build Status](https://api.cirrus-ci.com/github/cirruslabs/google-storage-proxy.svg)](https://cirrus-ci.com/github/cirruslabs/google-storage-proxy) HTTP proxy with REST API to interact with Google Cloud Storage Buckets -Simply allows to use `HEAD`, `GET` or `PUT` requests to check blob's availability, as well as downloading or uploading +Simply allows using `HEAD`, `GET` or `PUT` requests to check blob's availability, as well as downloading or uploading blobs to a specified GCS bucket. + +# Arguments + +* `port` - optional port to run the proxy on. By default, `8080` is used. +* `bucket` - GCS bucket name to store artifacts in. You can configure [Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle) + for this bucket separately using `gcloud` or UI. +* `prefix` - optional prefix for all objects. For example, use `--prefix=foo/` to work under `foo` directory in `bucket`.