bump to 0.5.1, update docs

Patrick Jackson · patjackson52 · commit 093d26c2a545 · 2020-06-12T16:59:17.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 ## Unreleased
 
+## [0.5.0] - 2020-06-11
+ - update lib dependency to api import, so core lib is included in redux-kotlin-threadsafe
 ## [0.5.0] - 2020-06-11
  - kotlin 1.3.72
  - createThreadSafeStore fun added for thread synchronized access
diff --git a/README.md b/README.md
@@ -44,15 +44,15 @@ kotlin {
   sourceSets {
         commonMain { //   <---  name may vary on your project
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.0"
+                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.1"
             }
         }
  }
 ```
 
 For JVM only:
 ```
-  implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.0"
+  implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.1"
 ```
 
 *Non threadsafe store is available.  Typical usage will be with the threadsafe store. [More info read here](https://www.reduxkotlin.org/introduction/getting-started)
diff --git a/gradle.properties b/gradle.properties
@@ -21,7 +21,7 @@ android.enableJetifier=true
 kotlin.code.style=official
 
 GROUP=org.reduxkotlin.redux-kotlin
-VERSION_NAME=0.5.0
+VERSION_NAME=0.5.1
 
 POM_ARTIFACT_ID=reduxkotlin
 POM_DESCRIPTION=Redux implementation for Kotlin.  Mulitiplatform supported.
diff --git a/lib-threadsafe/build.gradle b/lib-threadsafe/build.gradle
@@ -8,7 +8,7 @@ apply plugin: 'kotlinx-atomicfu'
 archivesBaseName = 'redux-kotlin-threadsafe'
 
 group 'org.reduxkotlin'
-version '0.5.0'
+version '0.5.1'
 
 kotlin {
     jvm()
diff --git a/lib/build.gradle b/lib/build.gradle
@@ -7,7 +7,7 @@ apply plugin: 'kotlin-multiplatform'
 archivesBaseName = 'redux-kotlin'
 
 group 'org.reduxkotlin'
-version '0.5.0'
+version '0.5.1'
 
 kotlin {
     jvm()
diff --git a/website/.gitignore b/website/.gitignore
@@ -1 +1,2 @@
-.now
+.now
+.vercel
diff --git a/website/docs/api/README.md b/website/docs/api/README.md
@@ -74,6 +74,7 @@ data class Store<State>(
 ### Top-Level Functions
 
 - [createStore(reducer: Reducer, preloadedState: State, enhancer: StoreEnhancer)](createStore.md)
+- [createThreadSafeStore(reducer: Reducer, preloadedState: State, enhancer: StoreEnhancer)](createThreadSafeStore.md)
 - [applyMiddleware(...middlewares)](applyMiddleware.md)
 - [compose(...functions)](compose.md)
 
diff --git a/website/docs/api/createSameThreadEnforcedStore.md b/website/docs/api/createSameThreadEnforcedStore.md
@@ -1,11 +1,11 @@
 ---
-id: createSameThreadEnforcedstore
+id: createsamethreadenforcedstore
 title: createSameThreadEnforcedStore
 sidebar_label: createSameThreadEnforcedStore
 hide_title: true
 ---
 
-# `createSameThreadEnforcedStore(reducer, preloadedState, enhancer)
+# `createSameThreadEnforcedStore(reducer, preloadedState, enhancer)`
 
 Creates a Redux [store](Store.md) that can only be accessed from the same thread.  
 Any call to the store's functions called from a thread other than thread from which  
diff --git a/website/docs/api/createThreadSafeStore.md b/website/docs/api/createThreadSafeStore.md
@@ -1,11 +1,11 @@
 ---
-id: createThreadSafeStore
+id: createthreadsafestore
 title: createThreadSafeStore
 sidebar_label: createThreadSafeStore
 hide_title: true
 ---
 
-# `createThreadSafeStore(reducer, preloadedState, enhancer)
+# `createThreadSafeStore(reducer, preloadedState, enhancer)`
 
 Creates a Redux [store](Store.md) that is may be accessed from any thread.
 
diff --git a/website/docs/introduction/GettingStarted.md b/website/docs/introduction/GettingStarted.md
@@ -33,7 +33,7 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.0"
+                implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.1"
             }
         }
     }
@@ -47,11 +47,11 @@ __For single platform project (i.e. just Android):__
 
 ```groovy
 dependencies {
-    implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.0"
+    implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.1"
 }
 ```
 
-NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.0" may be used.
+NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.1" may be used.
 [**More info on threading available here.**](/introduction/threading)
 
 ## Basic Example
diff --git a/website/docs/introduction/Threading.md b/website/docs/introduction/Threading.md
@@ -19,17 +19,20 @@ state.  Or 2 actions dispatched concurrently could cause an invalid state.
 
 **So you there are 3 options:**
 
-    1) Synchronize access to the store  - [createThreadSafeStore()](../api/createThreadSafeStore.md)
-    2) Only access the store from the same thread - [createSameThreadEnforcedStore()](../api/createSameThreadEnforcedStore.md)
-    3) Live in the wild west and access store anytime, any thread and live with consequences - NOT RECOMMENDED - [createStore()](../api/createStore.md)
+1) Synchronize access to the store  - [createThreadSafeStore()](../api/createThreadSafeStore.md)
+2) Only access the store from the same thread - [createSameThreadEnforcedStore()](../api/createSameThreadEnforcedStore.md)
+3) Live in the wild west and access store anytime, any thread
+    and live with consequences - NOT_RECOMMENDED - [createStore()](../api/createStore.md)
 
 ReduxKotlin allows all these, but most cases will fall into #1.
 
+## ThreadSafe
+
 Starting with ReduxKotlin 0.5.0 there is a threadsafe store which uses synchronization (AtomicFu library)
 to allow safe access to all the functions on the store.  This is the recommended usage for 90% of use cases.
 
 ```kotlin
-    val store = createThreadSafeStore(...)
+    val store = createThreadSafeStore(reducer, state)
 ```
 
 Who is the other 10%? If you are only targeting Javascript thread safety is not an issue, so
@@ -55,9 +58,13 @@ have do not have the enforcement in place yet.
 
 To use `same thread enforcement`:
 ```kotlin
-    val store = createSameThreadEnforcedStore(...)
+    val store = createSameThreadEnforcedStore(reducer, state)
 ```
 
+## Wild west - no enforcement
+
+`createStore()` may be used if the project is only a single threaded application (i.e. JS only), or you
+just want control access within your codebase(NOT_RECOMMENDED).
 
 ***IF*** you are using vanilla `createStore()`, then you may use an different artifact,  
 and avoid pulling in AtomicFu dependency:
@@ -67,7 +74,7 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                implementation "org.reduxkotlin:redux-kotlin:0.5.0"
+                implementation "org.reduxkotlin:redux-kotlin:0.5.1"
             }
         }
     }
diff --git a/website/i18n/en.json b/website/i18n/en.json
@@ -29,10 +29,18 @@
         "title": "compose",
         "sidebar_label": "compose"
       },
+      "api/createsamethreadenforcedstore": {
+        "title": "createSameThreadEnforcedStore",
+        "sidebar_label": "createSameThreadEnforcedStore"
+      },
       "api/createstore": {
         "title": "createStore",
         "sidebar_label": "createStore"
       },
+      "api/createthreadsafestore": {
+        "title": "createThreadSafeStore",
+        "sidebar_label": "createThreadSafeStore"
+      },
       "api/api-reference": {
         "title": "API Reference",
         "sidebar_label": "API Reference"
diff --git a/website/sidebars.json b/website/sidebars.json
@@ -45,6 +45,8 @@
     "API Reference": [
       "api/api-reference",
       "api/createstore",
+      "api/createthreadsafestore",
+      "api/createsamethreadenforcedstore",
       "api/store",
       "api/combinereducers",
       "api/applymiddleware",

Original file line number	Diff line number	Diff line change
`@@ -44,15 +44,15 @@ kotlin {`
`44`	`44`	`sourceSets {`
`45`	`45`	`commonMain { // <--- name may vary on your project`
`46`	`46`	`dependencies {`
`47`		`- implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.0"`
	`47`	`+ implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.1"`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`	```
`52`	`52`
`53`	`53`	`For JVM only:`
`54`	`54`	```
`55`		`- implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.0"`
	`55`	`+ implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.1"`
`56`	`56`	```
`57`	`57`
`58`	`58`	`*Non threadsafe store is available. Typical usage will be with the threadsafe store. [More info read here](https://www.reduxkotlin.org/introduction/getting-started)`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ kotlin {`
`33`	`33`	`sourceSets {`
`34`	`34`	`commonMain {`
`35`	`35`	`dependencies {`
`36`		`- implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.0"`
	`36`	`+ implementation "org.reduxkotlin:redux-kotlin-threadsafe:0.5.1"`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`	`}`
`@@ -47,11 +47,11 @@ __For single platform project (i.e. just Android):__`
`47`	`47`
`48`	`48`	```groovy
`49`	`49`	`dependencies {`
`50`		`- implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.0"`
	`50`	`+ implementation "org.reduxkotlin:redux-kotlin-threadsafe-jvm:0.5.1"`
`51`	`51`	`}`
`52`	`52`	```
`53`	`53`
`54`		`-NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.0" may be used.`
	`54`	`+NOTE: If threadsafety is not a concern (i.e. a JS only project) "org.reduxkotlin:redux-kotlin:0.5.1" may be used.`
`55`	`55`	`[More info on threading available here.](/introduction/threading)`
`56`	`56`
`57`	`57`	`## Basic Example`