Skip to content

Documentation updates #51

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 3, 2021
Merged

Documentation updates #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28fb100
Update README.md
bdlukaa Dec 3, 2021
87ca062
Update supabase.dart
bdlukaa Dec 3, 2021
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,18 @@ Supabase is an open source Firebase alternative. We are a service to:
- [x] Public Beta: Stable. No breaking changes expected in this version but possible bugs.
- [ ] Public: Production-ready

## Features

- [x] Null-safety

| Platform | Email Auth | Provider Auth | Database | Realtime | Storage |
| -------- | :--------: | :-----------: | :------: | :------: | :-----: |
| Android | ✅ | ✅ | ✅ | ✅ | ✅ |
| iOS | ✅ | ✅ | ✅ | ✅ | ✅ |
| macOS | ✅ | | ✅ | ✅ | ✅ |
| Windows | ✅ | | ✅ | ✅ | ✅ |
| Linux | ✅ | | ✅ | ✅ | ✅ |

## Getting Started

Import the package:
Expand Down
12 changes: 7 additions & 5 deletions lib/src/supabase.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ import 'package:supabase/supabase.dart';
import 'local_storage.dart';
import 'supabase_auth.dart';

/// Supabase instance. It must be initialized before used:
/// Supabase instance.
///
/// It must be initialized before used, otherwise an error is thrown.
///
/// ```dart
/// Supabase.initialize(...)
/// await Supabase.initialize(...)
/// ```
///
/// Use it:
Expand All @@ -23,7 +25,7 @@ class Supabase {
/// Gets the current supabase instance.
///
/// An [AssertionError] is thrown if supabase isn't initialized yet.
/// Call [Supabase.intialize] to initialize it.
/// Call [Supabase.initialize] to initialize it.
static Supabase get instance {
assert(
_instance._initialized,
Expand Down Expand Up @@ -61,8 +63,8 @@ class Supabase {
return _instance;
}

Supabase._privateConstructor();
static final Supabase _instance = Supabase._privateConstructor();
Supabase._();
static final Supabase _instance = Supabase._();

bool _initialized = false;

Expand Down