Skip to content

Commit

Permalink
Merge pull request #59 from Kitura/MISC-org_update
Browse files Browse the repository at this point in the history
Misc org update
  • Loading branch information
mbarnach authored Dec 10, 2020
2 parents 8418006 + 8506a4a commit f58f566
Show file tree
Hide file tree
Showing 112 changed files with 2,274 additions and 1,266 deletions.
6 changes: 3 additions & 3 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module: KituraContracts
author: IBM
github_url: https://github.com/IBM-Swift/KituraContracts/
author: IBM and Kitura project authors
github_url: https://github.com/Kitura/KituraContracts/

theme: fullwidth
clean: true
Expand All @@ -11,5 +11,5 @@ readme: README.md
skip_undocumented: false
hide_documentation_coverage: false

xcodebuild_arguments: [-project, KituraContracts.xcodeproj, -target, KituraContracts, LIBRARY_SEARCH_PATHS=.build/debug]
xcodebuild_arguments: []

2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ matrix:
env: SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT

before_install:
- git clone https://github.com/IBM-Swift/Package-Builder.git
- git clone https://github.com/Kitura/Package-Builder.git

script:
- ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR
8 changes: 4 additions & 4 deletions KituraContracts.podspec
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@

Pod::Spec.new do |s|
s.name = "KituraContracts"
s.version = "1.2.1"
s.version = "1.2.200"
s.summary = "KituraContracts is a library containing type definitions shared by client and server code."
s.homepage = "https://github.com/IBM-Swift/KituraContracts"
s.homepage = "https://github.com/Kitura/KituraContracts"
s.license = { :type => "Apache License, Version 2.0" }
s.author = "IBM"
s.module_name = 'KituraContracts'
s.osx.deployment_target = "10.11"
s.ios.deployment_target = "10.0"
s.tvos.deployment_target = "9.1"
s.watchos.deployment_target = "2.0"
s.source = { :git => "https://github.com/IBM-Swift/KituraContracts.git", :tag => s.version }
s.source = { :git => "https://github.com/Kitura/KituraContracts.git", :tag => s.version }
s.source_files = "Sources/**/*.swift"
s.dependency 'LoggerAPI', '~> 1.7'
s.dependency 'LoggerAPI', '~> 1.9'
end
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<p align="center">
<a href="https://www.kitura.io/">
<img src="https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
</a>
</p>


<p align="center">
<a href="https://ibm-swift.github.io/KituraContracts/index.html">
<a href="https://kitura.github.io/KituraContracts/index.html">
<img src="https://img.shields.io/badge/apidoc-KituraContracts-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/IBM-Swift/KituraContracts">
<img src="https://travis-ci.org/IBM-Swift/KituraContracts.svg?branch=master" alt="Build Status - Master">
<a href="https://travis-ci.org/Kitura/KituraContracts">
<img src="https://travis-ci.org/Kitura/KituraContracts.svg?branch=master" alt="Build Status - Master">
</a>
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
Expand All @@ -24,18 +24,18 @@

## Summary

KituraContracts is a library containing type definitions shared by client (e.g. [KituraKit](https://ibm-swift.github.io/KituraKit/)) and server (e.g. [Kitura](https://ibm-swift.github.io/Kitura)) code. These shared type definitions include [Codable Closure Aliases](https://ibm-swift.github.io/KituraContracts/Typealiases.html), [RequestError](https://ibm-swift.github.io/KituraContracts/Structs/RequestError.html), [QueryEncoder](https://ibm-swift.github.io/KituraContracts/Classes/QueryEncoder.html), [QueryDecoder](https://ibm-swift.github.io/KituraContracts/Classes/QueryDecoder.html), [Coder](https://ibm-swift.github.io/KituraContracts/Classes/Coder.html), [Identifier Protocol](https://ibm-swift.github.io/KituraContracts/Protocols/Identifier.html#/s:15KituraContracts10IdentifierP5valueSSv) and [Extensions](https://ibm-swift.github.io/KituraContracts/Extensions.html#/s:SS) to String and Int, which add conformity to the Identifier protocol.
KituraContracts is a library containing type definitions shared by client (e.g. [KituraKit](https://kitura.github.io/KituraKit/)) and server (e.g. [Kitura](https://kitura.github.io/Kitura)) code. These shared type definitions include [Codable Closure Aliases](https://kitura.github.io/KituraContracts/Typealiases.html), [RequestError](https://kitura.github.io/KituraContracts/Structs/RequestError.html), [QueryEncoder](https://kitura.github.io/KituraContracts/Classes/QueryEncoder.html), [QueryDecoder](https://kitura.github.io/KituraContracts/Classes/QueryDecoder.html), [Coder](https://kitura.github.io/KituraContracts/Classes/Coder.html), [Identifier Protocol](https://kitura.github.io/KituraContracts/Protocols/Identifier.html#/s:15KituraContracts10IdentifierP5valueSSv) and [Extensions](https://kitura.github.io/KituraContracts/Extensions.html#/s:SS) to String and Int, which add conformity to the Identifier protocol.

## Usage

KituraContracts represents the types and protocols that are common to both the [Kitura](https://github.com/IBM-Swift/Kitura) server and [KituraKit](https://github.com/IBM-Swift/KituraKit) client side library. If you are using Kitura or KituraKit, your project does not need to depend on KituraContracts explicitly.
KituraContracts represents the types and protocols that are common to both the [Kitura](https://github.com/Kitura/Kitura) server and [KituraKit](https://github.com/Kitura/KituraKit) client side library. If you are using Kitura or KituraKit, your project does not need to depend on KituraContracts explicitly.

#### Add dependencies

Add the `KituraContracts` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `KituraContracts` [release](https://github.com/IBM-Swift/KituraContracts/releases).
Add the `KituraContracts` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `KituraContracts` [release](https://github.com/Kitura/KituraContracts/releases).

```swift
.package(url: "https://github.com/IBM-Swift/KituraContracts.git", from: "x.x.x")
.package(url: "https://github.com/Kitura/KituraContracts.git", from: "x.x.x")
```

Add `KituraContracts` to your target's dependencies:
Expand Down Expand Up @@ -76,12 +76,12 @@ router.post("/users") { (user: User, respondWith: (User?, RequestError?) -> Void
The 1.x.x releases were tested on macOS and Linux using the Swift 4.1 binaries. Please note that this is the default version of Swift that is included in [Xcode 9.3](https://developer.apple.com/xcode/).

## API Documentation
For more information visit our [API reference](https://ibm-swift.github.io/KituraContracts/index.html).
For more information visit our [API reference](https://kitura.github.io/KituraContracts/index.html).

## Community

We love to talk server-side Swift and Kitura. Join our [Slack](http://swift-at-ibm-slack.mybluemix.net/) to meet the team!

## License

This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/IBM-Swift/KituraContracts/blob/master/LICENSE).
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/KituraContracts/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion Sources/KituraContracts/CodableQuery/Coder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import Foundation

/**
Class defining shared resources for the [QueryDecoder](https://github.com/IBM-Swift/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryDecoder.swift) and [QueryEncoder](https://github.com/IBM-Swift/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryEncoder.swift).
Class defining shared resources for the [QueryDecoder](https://github.com/Kitura/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryDecoder.swift) and [QueryEncoder](https://github.com/Kitura/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryEncoder.swift).

### Usage Example: ###
````swift
Expand Down
34 changes: 16 additions & 18 deletions docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
KituraContracts Docs
KituraContracts 1.2.200 Docs
</a>
(99% documented)
</p>
Expand All @@ -33,7 +33,7 @@
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/IBM-Swift/KituraContracts/">
<a class="header-link" href="https://github.com/Kitura/KituraContracts/">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
Expand Down Expand Up @@ -87,9 +87,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DateError.html">DateError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Double.html">Double</a>
</li>
Expand All @@ -111,6 +108,12 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Int8.html">Int8</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation11JSONEncoderC">JSONEncoder</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/String.html">String</a>
</li>
Expand All @@ -129,6 +132,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/UInt8.html">UInt8</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/UUID.html">UUID</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -244,7 +250,7 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>Classes</h1>
<p>The following classes are available globally.</p>

Expand All @@ -268,9 +274,9 @@ <h1>Classes</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Class defining shared resources for the <a href="https://github.com/IBM-Swift/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryDecoder.swift">QueryDecoder</a> and <a href="https://github.com/IBM-Swift/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryEncoder.swift">QueryEncoder</a>.</p>
<p>Class defining shared resources for the <a href="https://github.com/Kitura/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryDecoder.swift">QueryDecoder</a> and <a href="https://github.com/Kitura/KituraContracts/blob/master/Sources/KituraContracts/CodableQuery/QueryEncoder.swift">QueryEncoder</a>.</p>
<h3 id='usage-example' class='heading'>Usage Example:</h3>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">date</span> <span class="o">=</span> <span class="kt">Coder</span><span class="p">()</span><span class="o">.</span><span class="n">dateFormatter</span><span class="o">.</span><span class="nf">date</span><span class="p">(</span><span class="nv">from</span><span class="p">:</span> <span class="s">"2017-10-31T16:15:56+0000"</span><span class="p">)</span><span class="o">!</span>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">date</span> <span class="o">=</span> <span class="kt">Coder</span><span class="o">.</span><span class="n">defaultDateFormatter</span><span class="o">.</span><span class="nf">date</span><span class="p">(</span><span class="nv">from</span><span class="p">:</span> <span class="s">"2017-10-31T16:15:56+0000"</span><span class="p">)</span><span class="o">!</span>
</code></pre>

<a href="Classes/Coder.html" class="slightly-smaller">See more</a>
Expand All @@ -286,10 +292,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -337,10 +339,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -388,8 +386,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/KituraContracts" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/KituraContracts" target="_blank" rel="external">IBM and Kitura project authors</a>. All rights reserved. (Last updated: 2020-12-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit f58f566

Please sign in to comment.