Update README file of objc client

This commit is contained in:
geekerzp 2015-07-07 15:45:25 +08:00
parent 3f017af464
commit a25d3f2543
3 changed files with 25 additions and 15 deletions

View File

@ -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

View File

@ -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}}

View File

@ -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.