Google Git
Sign in
apache / openwhisk-catalog / 863a4bc2d731a312e706b140f211606c27c2b339
commit863a4bc2d731a312e706b140f211606c27c2b339[log] [tgz]
authorCarlos Santana <csantana23@gmail.com>Thu Feb 16 14:03:06 2017 -0500
committerGitHub <noreply@github.com>Thu Feb 16 14:03:06 2017 -0500
tree2d3317d66ae97b52b539eb4c61631cf1c247afec
parentf0ac5d71e8b73b9c5be5c8729b760c9dfb0cc086 [diff]
Update readme with links to individual READMEs per package (#188)

* move the weather package

* remove weather from main readme and added link

* addind end of line to weather readme

* move watson user docs into respective readmes per package

* fixing EOLs

* move slack docs to it's own readme

* move out the docs for github package

* remove push package info from readme

* adding todo for main readme

* move out websocket

* update installCatalog info in readme

* EOL fix
8 files changed
tree: 2d3317d66ae97b52b539eb4c61631cf1c247afec
  1. gradle/
  2. packages/
  3. tests/
  4. tools/
  5. .gitignore
  6. .travis.yml
  7. CONTRIBUTING.md
  8. credentials.json.enc
  9. gradlew
  10. gradlew.bat
  11. README.md
  12. settings.gradle
README.md

Openwhisk Catalog

Build Status License

This openwhisk-catalog maintains the package catalogs of openwhisk. In OpenWhisk, the catalog of packages gives you an easy way to enhance your app with useful capabilities, and to access external services in the ecosystem. Examples of external services that are OpenWhisk-enabled include IBM Watson API, the Weather Company, Slack, and GitHub.system packages and sample packages.

The catalog is available as packages in the /whisk.system namespace. See Browsing packages for information about how to browse the catalog by using the command line tool.

How to install openWhisk-catalog

Pre-requisites

  • openwhisk is installed.
  • Environment variable OPENWHISK_HOME is configured as the path to openwhisk source code directory.

Install openwhisk-catalog

We should be able to run the script installCatalog.sh to install the catalog like:

./installCatalog.sh [catalog_auth_key] [api_host]

The first argument catalog_auth_key, defines the secret key used to authenticate the openwhisk service. The second argument api_host, determines the location, where the openwhisk edge host is running, in the format of IP or hostname.

Existing packages in catalog

PackageDescription
/whisk.system/githuboffers a convenient way to use the GitHub APIs.
/whisk.system/slackoffers a convenient way to use the Slack APIs.
/whisk.system/watson-translatorPackage for text translation and language identification
/whisk.system/watson-speechToTextPackage to convert speech into text
/whisk.system/watson-textToSpeechPackage to convert text into speech
/whisk.system/weatherServices from the Weather Company Data for IBM Bluemix API
/whisk.system/websocketPackage to send messages to Web Socket server

How to create packages

If you want to create your own packages, openwhisk-package-template is a good package creation template to help you build, test and integrate new packages.

For more details about how to use these packages, you can go to the README.md under each package folder.