documentation

Author: krizzu

README.md

@@ -2,13 +2,25 @@
 
 Multiplatform SQLite storage for React Native Async Storage
 
-## Usage
+## Installation
+
+### Android
 
 ```groovy
 implementation("io.github.react-native-async-storage:async-storage-sqlite:VERSION")
 ```
 
-## Testing
+### iOS (CocoaPods)
+
+```ruby
+pod 'AsyncStorageSQLiteKMP', 'VERSION'
+```
+
+## Usage
+
+todo
+
+## Running tests
 
 Gradle tasks to run tests:
 
@@ -21,10 +33,3 @@ Gradle tasks to run tests:
 Re-running tests when tasks are up-to-date:
 
 `./gradlew :sqlite-storage:storageTests --rerun-tasks`
-
-## Release
-
-1. Update version in `package_info.json`
-2. Build binaries `bundleSQLiteStorage`
-3. Commit and tag 
-4. Push to repo

RELEASING.md

@@ -0,0 +1,25 @@
+## Release
+
+### Before release
+
+1. Run lint check via gradle task `spotlessCheck`
+2. Run tests via gradle task `storageTests`
+3. Run `pod lib lint` to verify Podspec
+
+### Versioning
+
+1. Update version in `package_info.json`
+2. Build binaries via `bundleSQLiteStorage` task
+3. Commit changes (name it `release: MAJOR.MINOR.PATCH`)
+4. Create tag (name it `MAJOR.MINOR.PATCH`)
+5. Push commit and tag to `main`
+6. Create Github release
+
+### Android
+
+https://vanniktech.github.io/gradle-maven-publish-plugin/central/#publishing-releases
+
+
+### iOS
+
+https://guides.cocoapods.org/making/making-a-cocoapod.html#submitting-open-source-code