README with examples and APIs

[mcollina]

The current README is missing both the examples and the API. We have not really much to show, but still it's worth adding stuff.

[AdrianRossouw]

yup. need to be gone over. i don't think the current examples are appropriate for the front page. we need somehtiung better.

[mcollina]

Have you had a look at this: https://github.com/GraftJS/graft/tree/master/example/orchestration?

[AdrianRossouw]

how would i. you just added it 3 hours ago =)

[AdrianRossouw]

I like that, but based on feedback i've had, I think the example should be something
that can be done in 2-3 files. one for the client, one for the server, but maybe one more for a spdy service.

[AdrianRossouw]

How about an app that allows you to upload an image and it pops up on everybody's screen in thumbnail form?

Client:

• On join send a stream to receive streams of new thumbs.
• New thumbs get loaded into a grid layout.
• allow drag and drop uploads
• Sends message with attached file stream and status

Server:

• Accepts stream from client
• Passes it through an imagemagick service
• Returns result to client.

Spdy server?:

• Just does the imagemagic part

Packages:

• drag-and-drop-files
• filereader-stream
• gm

[mcollina]

@AdrianRossouw I agree. Also, have a look at https://www.npmjs.org/package/resizer.

The problem is that we need something that can be like 20-30 lines in total, and all of that is too big. (even my orchestration is).

How about:

1) ws client calling 2) orchestration server, --- with where() clause 3) actual microservice

We can do the resize thing in the actual microservice, it's cool and nice.

[AdrianRossouw]

i think this is done.