diff --git a/README.md b/README.md index 2c59896..ddf670e 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,7 @@ Consider this flow while building an application. This will help you to overcome - Navigating page back and forth using frame functions - Has bindings for all Nativescript UI elements - Calling methods/setting attributes in the event object within elm (Will be improved in future) -- Simple and complex listviews templates -- and much more +- Simple and complex listviews templates and much more More features will be added soon. diff --git a/elm-native-js/README.md b/elm-native-js/README.md index 4a96a6c..8ec8a7b 100644 --- a/elm-native-js/README.md +++ b/elm-native-js/README.md @@ -1,3 +1,30 @@ # Elm custom elements bindings for Nativescript This library should be used with [elm-native](https://github.com/hariroshan/elm-native) elm library + +## How it works + +We will use [CustomElements](https://guide.elm-lang.org/interop/custom_elements.html) feature to create mobile UI elements with nativescript objects and control the nativescript object from elm. + +Here's a simple representation of how UI elements are created + +`Elm` -> `Nativescript` -> `Mobile` + +When we listen for / receive an event, + +`Mobile` -> `Nativescript` -> `Elm` + +Consider this flow while building an application. This will help you to overcome performance issues if you encounter them. + +### Supported Features + +- Dialog +- Page transitions animations +- Modal page +- Execution of OS specific property assignment and Native code (Be careful) +- Navigating page back and forth using frame functions +- Has bindings for all Nativescript UI elements +- Calling methods/setting attributes in the event object within elm (Will be improved in future) +- Simple and complex listviews templates and much more + +More features will be added soon. diff --git a/elm-native/README.md b/elm-native/README.md index 099bd4a..135aa30 100644 --- a/elm-native/README.md +++ b/elm-native/README.md @@ -27,7 +27,6 @@ Consider this flow while building an application. This will help you to overcome - Navigating page back and forth using frame functions - Has bindings for all Nativescript UI elements - Calling methods/setting attributes in the event object within elm (Will be improved in future) -- Simple and complex listviews templates -- and much more +- Simple and complex listviews templates and much more More features will be added soon.