Skip to content

Commit 3bd5fe7

Browse files
committed
🎨 update CHANGELOG and documentation for initial release of hyper_storage_flutter
1 parent 0468f56 commit 3bd5fe7

File tree

5 files changed

+28
-9
lines changed

5 files changed

+28
-9
lines changed
Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
## 1.0.0
1+
## 0.1.0
22

3-
- Initial version.
3+
- Initial release of hyper_storage
4+
- Support for multiple storage backends (InMemory included)
5+
- Type-safe storage operations (String, int, double, bool, DateTime, Duration, Lists, JSON)
6+
- Named containers for organized data storage
7+
- JSON serializable containers for custom objects
8+
- ItemHolder pattern for managing individual storage items
9+
- Listenable support for reactive data changes
10+
- Stream support for observing storage changes
11+
- Comprehensive test coverage (99.1%)

packages/hyper_storage/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,20 @@ Then, run `flutter pub get` or `dart pub get`.
2727

2828
## Usage
2929

30-
Initialize the storage. The default backend is `InMemoryBackend`.
30+
Initialize the storage with a backend. The `InMemoryBackend` is included by default for temporary storage.
3131

3232
```dart
3333
import 'package:hyper_storage/hyper_storage.dart';
3434
3535
void main() async {
36-
// Initialize the storage
37-
final storage = await HyperStorage.init();
36+
// Initialize the storage with InMemoryBackend
37+
final storage = await HyperStorage.init(backend: InMemoryBackend());
3838
3939
// Set a value
40-
await storage.set('name', 'Hyper Storage');
40+
await storage.setString('name', 'Hyper Storage');
4141
4242
// Get a value
43-
final name = await storage.get('name');
43+
final name = await storage.getString('name');
4444
print(name); // Output: Hyper Storage
4545
4646
// Close the storage

packages/hyper_storage/example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You can initialize `hyper_storage` with a specific backend. If no backend is pro
2323
```dart
2424
import 'package:hyper_storage/hyper_storage.dart';
2525
26-
final storage = await HyperStorage.init();
26+
final storage = await HyperStorage.init(backend: InMemoryBackend());
2727
```
2828

2929
### Using Other Backends
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
## 0.1.0
22

3-
* TODO: Describe initial release.
3+
- Initial release of hyper_storage_flutter
4+
- ValueListenable support for reactive UI updates
5+
- Stream support for ItemHolder and HyperStorage
6+
- Seamless Flutter integration with hyper_storage
7+
- Memory leak prevention through proper listener cleanup
8+
- Compatible with Flutter 3.35.0+

packages/hyper_storage_flutter/pubspec.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ dev_dependencies:
2121
flutter_lints: ^6.0.0
2222
coverage: ^1.15.0
2323

24+
topics:
25+
- flutter
26+
- storage
27+
- reactive
28+
- valuelistenable
29+
2430
flutter:
2531

2632
resolution: workspace

0 commit comments

Comments
 (0)