Merge pull request #68 from reduxkotlin/doc/0.5.5-update

update docs for 0.5.5

Author: patjackson52

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## [0.5.5] - 2020-08-16
+ - update to Kotlin 1.4.0
+ - added platforms (androidNativeArm32, androidNativeArm64, iosArm32, linuxArm64, linuxX64,
+  mingwX86, tvosArm64, tvosX64, watchosArm32, watchosArm64, watchosX86)
+ - remove spek & atrium deps and use plain kotlin tests & assertions. Tests run for all platforms now.
+ 
 ## [0.5.2] - 2020-07-03
  - publish all available platforms to maven
  - add CI/CD through github actions

README.md

@@ -3,6 +3,7 @@
 ![CI](https://github.com/reduxkotlin/redux-kotlin/workflows/CI/badge.svg)
 
 ![badge][badge-android]
+![badge][badge-ios]
 ![badge][badge-native]
 ![badge][badge-js]
 ![badge][badge-jvm]
@@ -27,7 +28,7 @@ Provide a standard redux implementation for Kotlin.  In doing so will foster a e
 
 Redux in Kotlin, and in mobile in particular, may differ a bit from javascript.  Many have found the basic pattern useful on Android & iOS leading to tens of opensource redux libraries in Kotlin, Java, and Swift, yet an ecosystem has yet to emerge.  A port of javascript redux is a good starting point for creating a standard and will aid in cross-pollination of middleware, store enhancers, & dev tools from the javascript world.  
 
-Redux has proven helpful for state managment in mobile. A multiplatform Kotlin implementation & ecosystem will increase developer productivity and code reuse across platforms.
+Redux has proven helpful for state management in mobile. A multiplatform Kotlin implementation & ecosystem will increase developer productivity and code reuse across platforms.
 
 [Droidcon NYC Slides](https://www.slideshare.net/PatrickJackson14/reduxkotlinorg-droidcon-nyc-2019)
 Video TBA
@@ -46,15 +47,15 @@ kotlin {
   sourceSets {
         commonMain { //   <---  name may vary on your project
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.2"
+                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.5"
             }
         }
  }
 ```
 
 For JVM only:
 ```
-  implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.2"
+  implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.5"
 ```
 
 *Non threadsafe store is available.  Typical usage will be with the threadsafe store. [More info read here](https://www.reduxkotlin.org/introduction/getting-started)

gradle/publish.gradle

@@ -20,27 +20,27 @@ dokka {
         path = kotlin.sourceSets.commonMain.kotlin.srcDirs[0]
         platforms = ["Common"]
     }
-    if (kotlin.sourceSets.getNames().contains("jvmMain")) {
-        sourceRoot {
-            // assuming there is only a single source dir...
-            path = kotlin.sourceSets.jvmMain.kotlin.srcDirs[0]
-            platforms = ["JVM"]
-        }
-    }
-    if (kotlin.sourceSets.getNames().contains("jsMain")) {
-        sourceRoot {
-            // assuming there is only a single source dir...
-            path = kotlin.sourceSets.jsMain.kotlin.srcDirs[0]
-            platforms = ["js"]
-        }
-    }
-    if (kotlin.sourceSets.getNames().contains("nativeMain")) {
-        sourceRoot {
-            // assuming there is only a single source dir...
-            path = kotlin.sourceSets.nativeMain.kotlin.srcDirs[0]
-            platforms = ["native"]
-        }
-    }
+//    if (kotlin.sourceSets.getNames().contains("jvmMain")) {
+//        sourceRoot {
+//            // assuming there is only a single source dir...
+//            path = kotlin.sourceSets.jvmMain.kotlin.srcDirs[0]
+//            platforms = ["JVM"]
+//        }
+//    }
+//    if (kotlin.sourceSets.getNames().contains("jsMain")) {
+//        sourceRoot {
+//            // assuming there is only a single source dir...
+//            path = kotlin.sourceSets.jsMain.kotlin.srcDirs[0]
+//            platforms = ["js"]
+//        }
+//    }
+//    if (kotlin.sourceSets.getNames().contains("nativeMain")) {
+//        sourceRoot {
+//            // assuming there is only a single source dir...
+//            path = kotlin.sourceSets.nativeMain.kotlin.srcDirs[0]
+//            platforms = ["native"]
+//        }
+//    }
 }
 
 def isReleaseBuild() {
@@ -76,10 +76,10 @@ task javadocsJar(type: Jar, dependsOn: dokka) {
 
 signing {
     required { isReleaseBuild() /*&& gradle.taskGraph.hasTask("uploadArchives") */ }
-    def signingKey = findProperty("GPG_SECRET") ?: System.getenv('GPG_SECRET') ?: ""
-    def signingPassword = findProperty("GPG_SIGNING_PASSWORD") ?: System.getenv('GPG_SIGNING_PASSWORD') ?: ""
-    useInMemoryPgpKeys(signingKey, signingPassword)
-    sign(publishing.publications)
+//    def signingKey = findProperty("GPG_SECRET") ?: System.getenv('GPG_SECRET') ?: ""
+//    def signingPassword = findProperty("GPG_SIGNING_PASSWORD") ?: System.getenv('GPG_SIGNING_PASSWORD') ?: ""
+//    useInMemoryPgpKeys(signingKey, signingPassword)
+//    sign(publishing.publications)
 }
 
 publishing {

website/docs/introduction/GettingStarted.md

@@ -33,7 +33,7 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.2"
+                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.5"
             }
         }
     }
@@ -47,11 +47,11 @@ __For single platform project (i.e. just Android):__
 
 ```groovy
 dependencies {
-    implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.2"
+    implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.5"
 }
 ```
 
-NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.2" may be used.
+NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.5" may be used.
 [**More info on threading available here.**](/introduction/threading)
 
 ## Basic Example

website/docs/introduction/Threading.md

@@ -74,7 +74,7 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin:0.5.2"
+                implementation "org.reduxkotlin:redux-kotlin:0.5.5"
             }
         }
     }