From a25d3f254312c9f0d8e4cf5ea825bf414ad318ff Mon Sep 17 00:00:00 2001 From: geekerzp Date: Tue, 7 Jul 2015 15:45:25 +0800 Subject: [PATCH] Update README file of objc client --- .../codegen/languages/ObjcClientCodegen.java | 1 + .../src/main/resources/objc/README.mustache | 19 ++++++++++++++++++ samples/client/petstore/objc/README.md | 20 +++++-------------- 3 files changed, 25 insertions(+), 15 deletions(-) create mode 100644 modules/swagger-codegen/src/main/resources/objc/README.mustache diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java index 314067c2ae0..0fdb19e806d 100644 --- a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java +++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java @@ -164,6 +164,7 @@ public class ObjcClientCodegen extends DefaultCodegen implements CodegenConfig { supportingFiles.add(new SupportingFile("Configuration-body.mustache", swaggerFolder, classPrefix + "Configuration.m")); supportingFiles.add(new SupportingFile("Configuration-header.mustache", swaggerFolder, classPrefix + "Configuration.h")); supportingFiles.add(new SupportingFile("podspec.mustache", "", podName + ".podspec")); + supportingFiles.add(new SupportingFile("README.mustache", "", "README.md")); } @Override diff --git a/modules/swagger-codegen/src/main/resources/objc/README.mustache b/modules/swagger-codegen/src/main/resources/objc/README.mustache new file mode 100644 index 00000000000..db2b1e5b31e --- /dev/null +++ b/modules/swagger-codegen/src/main/resources/objc/README.mustache @@ -0,0 +1,19 @@ +# {{podName}} + +## Requirements + +The API client library requires ARC (Automatic Reference Counting) to be enabled in your Xcode project. + +## Installation + +To install it, put the API client library in your project and then simply add the following line to your Podfile: + +```ruby +pod "{{podName}}", :path => "/path/to/lib" +``` + +## Author + +{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}} +{{/hasMore}}{{/apis}}{{/apiInfo}} + diff --git a/samples/client/petstore/objc/README.md b/samples/client/petstore/objc/README.md index 22a5fc2634f..4cce2c882bb 100644 --- a/samples/client/petstore/objc/README.md +++ b/samples/client/petstore/objc/README.md @@ -1,29 +1,19 @@ # SwaggerClient -[![CI Status](http://img.shields.io/travis/geekerzp/SwaggerClient.svg?style=flat)](https://travis-ci.org/geekerzp/SwaggerClient) -[![Version](https://img.shields.io/cocoapods/v/SwaggerClient.svg?style=flat)](http://cocoapods.org/pods/SwaggerClient) -[![License](https://img.shields.io/cocoapods/l/SwaggerClient.svg?style=flat)](http://cocoapods.org/pods/SwaggerClient) -[![Platform](https://img.shields.io/cocoapods/p/SwaggerClient.svg?style=flat)](http://cocoapods.org/pods/SwaggerClient) - -## Usage - -To run the example project, clone the repo, and run `pod install` from the Example directory first. - ## Requirements +The API client library requires ARC (Automatic Reference Counting) to be enabled in your Xcode project. + ## Installation -SwaggerClient is available through [CocoaPods](http://cocoapods.org). To install -it, simply add the following line to your Podfile: +To install it, put the API client library in your project and then simply add the following line to your Podfile: ```ruby -pod "SwaggerClient" +pod "SwaggerClient", :path => "/path/to/lib" ``` ## Author -geekerzp, geekerzp@gmail.com +apiteam@swagger.io -## License -SwaggerClient is available under the MIT license. See the LICENSE file for more info.