Skip to content

Commit

Permalink
chore: Clean up README (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
dnys1 authored Jan 24, 2024
1 parent 5c93541 commit 1eb0938
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

Celest is the Flutter cloud platform. We enable Flutter and Dart developers to declaratively define their backend infrastructure in Dart.

<!-- Our initial CLI release is available to download [here](https://celest.dev/download). It includes the full experience of serverless functions in a local environment. To learn more about our CLI and all the features, visit our [documentation](https://celest.dev/docs). -->

And to stay up-to-date on the future of Celest, including managed deployments, join our waitlist at [celest.dev](https://celest.dev).

## Getting started with Celest
Expand Down Expand Up @@ -39,7 +37,7 @@ Once you are in your Flutter app directory, run the following command to initial
$ celest start
```

Once the command executes, Celest will spin up a local environment and watch for changes made to your backend, and code-generate a Dart client for you to test your changes.
Once the command executes, Celest will spin up a local environment and watch for changes made to your backend, generating a Dart client for you to test your changes.

The CLI will also create a folder in your project called `celest`, which will include the following files.

Expand All @@ -51,7 +49,7 @@ flutter_app/
├── functions/ # Celest Functions folder
| └── greeting.dart # Example API file
├── lib/
│ │── client.dart # Code-generated client for your Flutter app
│ │── client.dart # Generated client for your Flutter app
│ ├── models.dart # Custom API models
│ └── exceptions.dart # Custom API exceptions
└── test/ # Tests for your backend
Expand All @@ -75,13 +73,11 @@ That's all you need to define your API! Now, you can connect your Flutter app to

```dart
import 'package:flutter/material.dart';
// Import the code-generated Celest client
// highlight-next-line
// Import the generated Celest client
import 'package:celest_backend/client.dart';
void main() {
// Initializes Celest in your Flutter app
// highlight-next-line
celest.init();
runApp(const MyApp());
}
Expand All @@ -99,7 +95,6 @@ class MyApp extends StatelessWidget {
body: Center(
child: FutureBuilder(
// Call your function using the Celest client
// highlight-next-line
future: celest.functions.greeting.sayHello('Celest'),
builder: (_, snapshot) => switch (snapshot) {
AsyncSnapshot(:final data?) => Text(data),
Expand Down

0 comments on commit 1eb0938

Please sign in to comment.