Richer README

[juliangruber]

• It would be nice if it linked to some Notion pages, for extra context docs: add contributing. #53 #55

The goals of the README should be (imo):

1. Elevator pitch of the project docs: add elevator pitch #59
2. How to run a rudimentary example docs: add high-level example. #53 #54
3. How to create a basic module docs: add high-level example. #53 #54
4. How to contribute (either through code, or telling us use cases) docs: add contributing. #53 #55
5. High level project roadmap docs: add contributing. #53 #55

[juliangruber]

Via @bajtos:

• README in workspace root - this is the landing page for our GitHub repo. https://github.com/filecoin-station/zinnia
• README for Zinnia CLI crate zinnia - this is the landing page on crates.io. https://crates.io/crates/zinnia (sourced from https://github.com/filecoin-station/zinnia/blob/main/cli/README.md)

[juliangruber]

How to create a basic module

@bajtos are we ready to talk about zinnia "modules" yet? Is a module simply a js file with 0-n files it imports from?

[bajtos]

How to create a basic module

@bajtos are we ready to talk about zinnia "modules" yet? Is a module simply a js file with 0-n files it imports from?

Yes, I think we are ready.

We don't support module imports yet (see #43), so right now a module is simply a single JS file that implements a long-running process.

I know the missing support for ES Module imports is a poor DX; I'd like to fix it soon after the first public alpha. I propose mentioning #43 in the text explaining that a module must be a single file.

[bajtos]

Closing as done. Please reopen if you disagree, @juliangruber