Update README.md
1 file changed
tree: 22efc1375061b59bdc6aca124f8892adde30f08c
  1. WhiskSwiftTools/
  2. WhiskSwiftTools.xcodeproj/
  3. .gitignore
  4. CLA-CORPORATE.md
  5. CLA-INDIVIDUAL.md
  6. CONTRIBUTING.md
  7. LICENSE.txt
  8. README.md
  9. WhiskSwiftTools-Bridging-Header.h
README.md

WhiskSwiftTools

A collection of tools to help developers use OpenWhisk on OS X. Implemented in Swift 3 because Swift 3.

More documentation coming soon!

Features

wsktool

A small CLI tool that allows developers to install OpenWhisk “projects” into the OpenWhisk backend. A project contains sets of actions (JS and Swift), triggers, and rules with a single command wsktool install. You can do the opposite with wsktool uninstall. Documentation on the structure of an OpenWhisk project is coming soon. You can see an example project here

wsktool supports referencing depedencies on OpenWhisk projects in Github. It will automatically download, bind, and install these with the main project.

WhiskKit

A Swift 3 set of protocols and classes that lets you implement actions in Xcode. Provides an Xcode to OpenWhisk bridge via wsktool that allows you to directly install Xcode-based OpenWhisk actions into OpenWhisk.

Building

This code is built using the Xcode 8 beta 2 with the Swift 3 tech preview 2 toolchain.

There is a dependency on an ObjC project ZipArchive. OS X CLI targets and frameworks don't play together very well. The “easiest” way to reference it is to add the code manually to WhiskSwiftTools. Clone ZipArchive and install per the documentations on the ZipArchive readme. Copy the SSZipArchive folder into the project folder and link to the libz library. WhiskSwiftTOols includes bridging header file you can reference.

License

Copyright 2015-2016 IBM Corporation

Licensed under the Apache License, Version 2.0 (the “License”).

Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an “as is” basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.