Skip to content

Commit

Permalink
updated readme and changelogs (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
ArindomGhosh authored Mar 27, 2023
1 parent 887dfee commit f7e8ad9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ All the notable changes in the project would be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)

## [Unreleased](https://github.com/ArindomGhosh/stategenie/compare/v1.1.0...main)
## [Unreleased](https://github.com/ArindomGhosh/stategenie/compare/v1.2.0...main)

## [1.2.0](https://github.com/ArindomGhosh/stategenie/compare/v1.1.0...v1.2.0)
### Modified
- kotlin: upgraded to `Kotlin` version-1.8.0.
- KotlinCompileTesting: upgraded `kotlin-compile-testing-ksp` to version-1.5.0.

## [1.1.0](https://github.com/ArindomGhosh/stategenie/compare/v1.0.0...v1.1.0)
### Added
- DataStateGenie: Generate ui-state data class with update extention function.
- DataStateGenie: Generate ui-state data class with update extension function.
- wiki: Wiki pages updated to ease the readability.

### Modified
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ StateGenie provides:
- `@StateGenie`: To generate `sealed interface` representing a defined set of states.
It gives you the flexibility of reusing a base model in different scenarios while also enabling you to add new
models over them based on your requirements reducing the repeated boiler plate code. Link to the [@StateGenie wiki](https://github.com/ArindomGhosh/stategenie/wiki/@StateGenie)
- `@DataStateGenie`: To generate a single `data class` representing UiState and extention functions to update individual parameters, loading state and error object of subtype of Throwable and default constructor function to get the default UiState. Link to the [@DataStateGenie wiki](https://github.com/ArindomGhosh/stategenie/wiki/@DataStateGenie)
- `@DataStateGenie`: To generate a single `data class` representing UiState and extension functions to update individual parameters,
loading state and error object of subtype of Throwable and default constructor function to get the default UiState. Link to the [@DataStateGenie wiki](https://github.com/ArindomGhosh/stategenie/wiki/@DataStateGenie)

### Gradle Setup
1. Enable KSP in your app or module `build.gradle.kts`:
```kotlin
plugins {
id("com.google.devtools.ksp") version "1.7.20-1.0.7"
id("com.google.devtools.ksp") version "1.8.0-1.0.9"
}
```

Expand Down

0 comments on commit f7e8ad9

Please sign in to comment.