diff --git a/README.md b/README.md index 0897cf5..6603f4d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ -XamAndroidSettings +Xamarin Shared Preference Abstraction ================== -Abstraction around shared settings in Android xamarin +Abstraction around shared settings in Android Xamarin + +## How to use: + +New up a settingskey class + +````c# + +var sk = new SharedSettingsAbstraction.Setting.SettingsKey("KeyName", "PreferenceName", "DefaultValuehere"); + var setting = sk.getSetting(Context con) + var setsetting = sk.SetSetting(Context con, "New Value!") + +```` diff --git a/Setting/SettingsKey.cs b/Setting/SettingsKey.cs index eb5d124..88bd375 100644 --- a/Setting/SettingsKey.cs +++ b/Setting/SettingsKey.cs @@ -38,11 +38,11 @@ namespace SharedSettingsAbstraction.Setting } /// - /// Get Setting, if it cannot find it or cast properly it will return default setting + /// Gets the setting /// - /// Context - /// SettingsKey - public SettingsKey getSetting(Context con ) + /// context + /// + public T getSetting(Context con ) { var shared = con.GetSharedPreferences(_preferenceName, FileCreationMode.WorldReadable); try @@ -55,7 +55,7 @@ namespace SharedSettingsAbstraction.Setting value = (T)_defaultValue; } - return this; + return value; } /// /// Set the setting with a new setting