Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarified experimental nature of crux in its own section, which state… #288

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions docs/src/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

Crux is an **experimental** approach to building cross-platform applications
Crux is an approach to building cross-platform applications
mhedgpeth marked this conversation as resolved.
Show resolved Hide resolved
with better testability, higher code and behavior reuse, better safety,
security, and more joy from better tools.

Expand Down Expand Up @@ -66,7 +66,7 @@ will result in build failures in the Shell.

## Goals

We set out to prove this architecture to find a better way of building apps
We set out to find a better way of building apps
across platforms. You can read more [about our motivation](./motivation.md). The
overall goals of Crux are to:

Expand All @@ -78,3 +78,20 @@ overall goals of Crux are to:
- Separate the behavior from the look and feel and interaction design
- Use the native UI tool kits to create user experience that is the best fit for
a given platform

## Path to 1.0

Crux is used in production apps today, at least one quite large one. In that sense
we consider it production ready. However, to truly be at 1.0 with a more stable
API, we will take the following steps:
mhedgpeth marked this conversation as resolved.
Show resolved Hide resolved

* Improved documentation, code examples, and example apps for newcomers
* Improved onboarding experience, with less boilerplate code that end users have
to deal with
* Better FFI code generation to enable support for more Shells (e.g. .NET,
Flutter) which will also enable Desktop apps in Windows
mhedgpeth marked this conversation as resolved.
Show resolved Hide resolved
* Revised capabilities and effects to allow
for [app composition](./guide/composing.md) in larger apps
mhedgpeth marked this conversation as resolved.
Show resolved Hide resolved

Until then, we hope you will work with us on the rough edges, and factor in
frequent API updates as we evolve.
mhedgpeth marked this conversation as resolved.
Show resolved Hide resolved