Move the usage examples out of the readme

lune-climate / ts-results-es

A TypeScript implementation of Rust's Result and Option.

MIT License

98 stars 8 forks source link

Closed jstasiak closed 4 months ago

jstasiak commented 4 months ago

Following up the work started in [1].

If we squint a little these examples are tutorial-like, let's put them in the tutorials section.

Following the Diataxis framework[2] for structuring the documentation.

[1] 633ccad330e8 ("Set up an initial documentation structure (#81)") [2] https://diataxis.fr/

jstasiak commented 4 months ago

Open question: should the section be called "Tutorial" or maybe "Getting started"?