Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

Commit 516164d

Browse files
kerryspchangtardieu
authored andcommitted
update docs (#39)
* Updated README.md, docs/README/md and many screenshots in docs/ Added a new tutorial docs/translateApp.md * updated docs for composer v2 fixed typos
1 parent 9c62081 commit 516164d

File tree

12 files changed

+441
-291
lines changed

12 files changed

+441
-291
lines changed

README.md

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,37 @@ Composer is a new programming model from [IBM
66
Research](https://ibm.biz/serverless-research) for composing [IBM
77
Cloud Functions](https://ibm.biz/openwhisk), built on [Apache
88
OpenWhisk](https://github.com/apache/incubator-openwhisk).
9-
With composer, developers can build even more
10-
serverless applications including using it for IoT, with workflow
9+
With composer, developers can build even more serverless applications including using it for IoT, with workflow
1110
orchestration, conversation services, and devops automation, to name a
1211
few examples.
1312

14-
Composer extends Functions and sequences with more powerful control
15-
flow and automatic state management.
16-
Composer helps express cloud-native apps that are serverless by
17-
construction: scale automatically, pay as you go and not for idle time.
18-
19-
The [IBM Cloud functions shell](https://github.com/ibm-functions/shell)
20-
offers a CLI and graphical interface for fast, incremental, iterative,
21-
and local development of serverless apps. Some additional highlights
22-
of the shell include:
23-
24-
* Edit your code and program using your favorite text editor, rather than using a drag-n-drop UI.
25-
* Validate compositions with readily accessible visualizations, without switching tools or using a browser.
26-
* Deploy and invoke compositions using familiar CLI commands.
27-
* Debug invocations with either familiar CLI commands or readily accessible visualizations.
28-
29-
Composer and shell are currently available as IBM Research
30-
previews. We are excited about both and are looking forward to what
31-
compositions you build and run using [IBM Cloud
32-
Functions](https://ibm.biz/openwhisk) or directly on [Apache
13+
Programming compositions for IBM Cloud Functions is done via a new developer tool called [IBM Cloud Shell](https://github.com/ibm-functions/shell), or just _Shell_. Shell offers a CLI and graphical interface for fast, incremental, iterative, and local development of serverless apps. Composer and shell are currently available as IBM Research previews. We are excited about both and are looking forward to the compositions you build and run using [IBM CloudFunctions](https://ibm.biz/openwhisk) or directly on [Apache
3314
OpenWhisk](https://github.com/apache/incubator-openwhisk).
3415

16+
This repository includes:
17+
* a [composer](composer.js) node.js module to author compositions using JavaScript
18+
* a [compose](bin/compose) shell script for deploying compositions,
19+
* a [tutorial](docs/README.md) for getting started,
20+
* a [reference manual](docs/COMPOSER.md),
21+
* example compositions in the [samples](samples) folder,
22+
* tests in the [test](test) folder.
23+
24+
## Getting started
25+
* [Introduction to Serverless Composition](docs/README.md): Setting up your programming environment and getting started with Shell and Composer
26+
* [Building a Serverless Translate Bot with Composition](docs/tutorials/translateBot/README.md): A more advanced tutorial that describes using Composition to build a serverless Slack chatbot that does language translation.
27+
* [Learning more about Composer](docs/COMPOSER.md), a Node.js module to author compositions using JavaScript
28+
29+
## Videos
30+
* [IBM Cloud Shell YouTube channel](https://www.youtube.com/channel/UCcu16nIMNclSujJWDOgUI_g): The channel hosts demo videos of IBM Cloud Shell, including editing a composition [using a built-in editor](https://youtu.be/1wmkSYl7EDM) or [an external editor](https://youtu.be/psqoysnVgE4), and [visualizing a composition's execution](https://youtu.be/jTaHgDQDZnQ).
31+
* Watch [our presentation at Serverlessconf'17](https://acloud.guru/series/serverlessconf/view/ibm-cloud-functions) about Composition and Shell
32+
33+
## Example applications
34+
* A _Serverless Superman_ [Twitter Bot](https://www.raymondcamden.com/2017/10/20/upgrading-serverless-superman-to-ibm-composer/)
35+
* An app that [relays SMS to email](https://medium.com/openwhisk/a-composition-story-using-ibm-cloud-functions-to-relay-sms-to-email-d67fc65d29c)
36+
37+
## Feedback
3538
We welcome your feedback and criticism. Find bugs and we will squash
3639
them. And will be grateful for your help. As an early adopter, you
3740
will also be among the first to experience even more features planned
3841
for the weeks ahead. We look forward to your feedback and encourage
3942
you to [join us on slack](http://ibm.biz/composer-users).
40-
41-
This repository includes:
42-
43-
* a [composer](composer.js) node.js module to author compositions using JavaScript,
44-
* a [compose](bin/compose) shell script for deploying compositions,
45-
* a [tutorial](docs/README.md),
46-
* a [reference manual](docs/COMPOSER.md),
47-
* example compositions in the [samples](samples) folder,
48-
* tests in the [test](test) folder.

0 commit comments

Comments
 (0)