From 3d2c0c73825b37a8954bb5ec0de27e2da9431c61 Mon Sep 17 00:00:00 2001 From: Adarsha Date: Sat, 18 Apr 2015 00:33:46 +0530 Subject: [PATCH] Update README.md Added brief description of the project --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9485ca..5a7d936 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # FeatherLite -A light weight (feather lite) toolkit to aid in MVVM development for WIndows Phone 8+ systems. Inspired by MVVMLight, but uses a sub set +A light weight (feather lite) toolkit to aid in MVVM development for WIndows Phone 8+ systems. Inspired by MVVMLight, but mostly independent implementation. I created this while developing Windows Phone applications, so I have not tested them in any other .Net flavors (like WPF, WinRT etc). It provides following features: + +• A Bindable Object for UI and an Observable Object for Models with easy to use Property CHange notifier. +Just derive your classes from one of them, and call your setter + + bool _isInEditMode; + public bool IsInEditMode + { + get { return _isInEditMode; } + set { SetProperty (ref _isInEditMode, value); } + } + +`SetProperty` will take care of raising both `INotifyPropertyChanging` and `INotifyPropertyChanged` interface clients. + +• An easy to use Application settings helper which lets you save a setting and retrive it in any class as easy as + + public static bool AutoPaused + { + get { return AppSettings.GetValue (DefaultValue: false); } + set + { + if ( AppSettings.SetValue (Value: value) ) + AppSettings.Save (); + } + } + +• Async helper class for storing /retrieving files to and from Application Isolated storage. + +• Bindable application bar/commands + +• Navigation service + +*Known Issues*: +The messaging component creates a hard reference to all classes registering for messages (as an action delegate is passed as an input). I was not able to find a workaround which suited rest of my design. I just called CleanUp in every class and took care of Unregistring from messages.