Skip to content

Rewrite project README #12

Description

@frenchja

Overview

@robertzk @peterhurford

We can't guarantee that anyone that stumbles upon syberia/examples will have seen the docs or be following the docs. I propose adding a Get Started in 2 Minutes example using Titanic to the documentation.

In addition, should we edit the Prereqs to include less detail about Syberia's components and instead focus on a quick explanation of lockbox and installation?

Last, adding links to concrete file examples to the Structure may help enhance the clarity of that section and highlight the expected difference between an initializer and an application configuration.

Tasks

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions