Skip to content

Commit

Permalink
Removed libs from .gitignore, doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
AOrobator committed Sep 23, 2019
1 parent 643d9d1 commit 4727033
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Expand Up @@ -89,9 +89,7 @@ fastlane/test_output
# End of https://www.gitignore.io/api/swift,xcode

# From redux
node_modules
dist
lib
es
coverage

Expand Down
18 changes: 9 additions & 9 deletions docs/introduction/GettingStarted.md
Expand Up @@ -8,15 +8,15 @@ hide_title: true
# Getting Started with ReduxKotlin

ReduxKotlin is a predictable state container for Kotlin apps that supports all platforms that Kotlin
can target (JVM, native, JS, WASM).
can target (JVM, Native, JS, WASM).

ReduxKotlin is a port of [Redux for Javascript](https://redux.js.org) that aims to become a standard
implementation of Redux for Kotlin. Much of the information on [redux.js.org](https://redux.js.org)
applies to ReduxKotlin, however, there is also a lot of Javascript specific information that may
_not_ apply to ReduxKotlin. This site documents how to get started and examples of using ReduxKotlin
in projects. There are suggestions and examples, but ultimately the core ReduxLibrary is not
opinionated. How you use it in your project is up to you. This site will continue to be updated as
Kotlin multiplatform matures.
_not_ apply to ReduxKotlin. This site documents how to get started with ReduxKotlin and provides
examples of using ReduxKotlin in projects. There are suggestions and examples, but ultimately the
core ReduxLibrary is not opinionated. How you use it in your project is up to you. This site will
continue to be updated as Kotlin multiplatform matures.


## Installation
Expand Down Expand Up @@ -66,8 +66,8 @@ That's it!
* This is a reducer, a pure function with (state, action) -> state signature.
* It describes how an action transforms the state into the next state.
*
* The shape of the state is up to you: it can be a primitive, an array, an object,
* Usually this will be a data class. The copy method is useful for creating the new state.
* The shape of the state is up to you: it can be a primitive, an array, an object, etc.
* Usually this will be a data class, because the copy method is useful for creating the new state.
* In this contrived example, we are just using an Int for the state.
*
* In this example, we use a `when` statement and type checking, but other methods are possible,
Expand All @@ -81,7 +81,7 @@ fun reducer(state: Int, action: Action) =
}

/**
* Actions are plain objects that represent a action in the app. These can be
* Actions are plain objects that represent an action in the app. These can be
* plain objects or data classes and have fields that hold data necessary for
* the reducer to update the state.
*/
Expand Down Expand Up @@ -144,7 +144,7 @@ be up to you. Redux looks very promising as a pattern for multiplatform apps tar
& possibly web. Especially considering the new declarative UI frameworks Jetpack Compose and
SwiftUI. Many of the samples and multiplatform patterns are experimental at this point. The library
itself is stable, however the best practices for multiplatform apps are still being decided and the
ecostystem is still forming. For anyone interested, this is opportunity to contribute to libraries
ecosystem is still forming. For anyone interested, this is an opportunity to contribute to libraries
and samples.

This site will continue to grow and post examples, best practices, FAQs, and tutorials.
Expand Down

0 comments on commit 4727033

Please sign in to comment.