From 93fcb22698993625fc5bba20b7589c0623dd1f79 Mon Sep 17 00:00:00 2001 From: Tommaso Piazza Date: Sun, 21 Aug 2016 23:57:46 +0200 Subject: [PATCH] Updating README.md --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 85e5925..76ddc82 100644 --- a/README.md +++ b/README.md @@ -81,21 +81,23 @@ To use configurations other than the ``default`` profile set the ``$AWS_PROFILE` The Romefile has two purposes: -1. Specifies what S3 bucket to use - [S3Bucket] section. This section is __required__. +1. Specifies what S3 bucket to use - [Cache] section. This section is __required__. 1. Allows to use custom name mappings between repository names and framework names - [RepositoryMap] section. This section is __optional__ and can be omitted. -A Romefile looks like this +A Romefile looks like this: ``` -[S3Bucket] - ios-dev-bucket +[Cache] + S3-Bucket = ios-dev-bucket [RepositoryMap] - HockeySDK-iOS HockeySDK - awesome-framework-for-cat-names CatFramework - better-dog-names DogFramework + HockeySDK-iOS = HockeySDK + awesome-framework-for-cat-names = CatFramework + better-dog-names = DogFramework ``` +A Romefile is the [INI format](https://en.wikipedia.org/wiki/INI_file) + #### S3Bucket section This section contains the name of the S3 bucket you want Rome to use to upload/download. @@ -119,12 +121,13 @@ as opposed to `HockeySDK-iOS`, `awesome-framework-for-cat-names` and `better-dog simply add a `[RepositoryMap]` section to your `Romefile` and specify the following mapping: ``` -[S3Bucket] - ios-dev-bucket +[Cache] + S3-Bucket = ios-dev-bucket [RepositoryMap] - awesome-framework-for-cat-names CatFramework - better-dog-names DogFramework + HockeySDK-iOS = HockeySDK + awesome-framework-for-cat-names = CatFramework + better-dog-names = DogFramework ``` ### Usage