docs: core

Author: Krzysztof Borowy

README.md

@@ -1,6 +1,6 @@
 # Async Storage
 
-A storage system for React Native.
+A persistent data storage solution for your next mobile, web or desktop application. 
 
 ## Work in progress
 
@@ -10,8 +10,22 @@ If you're looking for published and operational Async Storage version, please ch
 
 If you'd like to see the progress of v2, [please visit Project page.](https://github.com/react-native-community/async-storage/projects/1) 
 
-## Running Examples
+## Features
+
+todo
+
+## Documentation
+
+todo
+
+## Available storage backends
+
+- [Legacy](./packages/storage-legacy/README.md)
+
+
+## License
+
+MIT
 
-### React Native
 
 

packages/core/README.md

@@ -1,35 +1,63 @@
 # Async Storage Core
 
-Main Async Storage component. 
+Public-facing API of Async Storage. 
 
-## Installation
+## Install
 
 ```bash
 $ yarn install @react-native-community/async-storage
 ```
 
-## Usage
+## API
 
-Use `AsyncStorageFactory` to create your Async Storage instance 
 
+### `AsyncStorageFactory`
+
+A factory module for `AsyncStorage` instance with selected storage backend attached. 
 
-```typescript
 
+```typescript
 // storage.js
 
 import ASFactory from '@react-native-community/async-storage'
 
 // use any available Storage Backend
 const storageBackend = new StorageBackend();
 
-const mobileStorage = ASFactory.create(storageBackend);
+const mobileStorage = ASFactory.create(storageBackend, options);
 
 export default mobileStorage;
 ```
 
-## Providing a storage model
 
-You can provide a `Model` type when creating Async Storage, to have a fully typed storage. 
+**Factory options**
+
+`AsyncStorageFactory.create` accepts an options object, that enables additional features.
+
+
+- *logger*
+
+```typescript
+type logger = ((action: LoggerAction) => void) | boolean;
+``` 
+
+Used to log `AsyncStorage` method calls and used arguments.
+You can provide your own implementation or use provided default logger (enabled by default in DEV mode).
+
+
+- *errorHandler*
+
+```typescript
+type errorHandler = ((error: Error | string) => void) | boolean;
+````
+
+Used to report any errors thrown.
+You can provide your own implementation or use provided default error handler (enabled by default in DEV mode).
+
+
+**Providing a storage model**
+
+If you know the structure of the stored data upfront, you can use the full potential of the type system, by providing a type argument to  `AsyncStorageFactory.create<T>` method.
 
 
 ```typescript
@@ -43,17 +71,19 @@ type StorageModel = {
   preferences: {
     darkModeEnabled: boolean;
   };
-  subscribedChannels: Array<Channel>;
+  subscribedChannels: Array<string>;
   onboardingCompleted: boolean;
 };
 
 // use any available Storage Backend
 const storageBackend = new StorageBackend();
 
+
 const storage = ASFactory.create<StorageModel>(storageBackend);
 
 ```
 
 ## License
 
-MIT.
+MIT
+

packages/core/types/index.d.ts

@@ -110,9 +110,6 @@ export type LoggerAction = {
 };
 
 // Helper types
-
-export type StorageModel<T> = T extends IStorageBackend<infer V> ? V : any;
-
 export type EmptyStorageModel = {[key in symbol | number | string]: any};
 
 export type StorageOptions = {

packages/storage-legacy/README.md

@@ -0,0 +1,3 @@
+# Storage Backend: Legacy
+
+todo