added readme

This commit is contained in:
Tommy Parnell
2014-02-23 12:58:41 -05:00
parent 382aea9431
commit 1d9ee47ee6
2 changed files with 19 additions and 7 deletions

View File

@@ -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<string>("KeyName", "PreferenceName", "DefaultValuehere");
var setting = sk.getSetting(Context con)
var setsetting = sk.SetSetting(Context con, "New Value!")
````

View File

@@ -38,11 +38,11 @@ namespace SharedSettingsAbstraction.Setting
}
/// <summary>
/// Get Setting, if it cannot find it or cast properly it will return default setting
/// Gets the setting
/// </summary>
/// <param name="con">Context</param>
/// <returns>SettingsKey<T></returns>
public SettingsKey<T> getSetting(Context con )
/// <param name="con">context</param>
/// <returns></returns>
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;
}
/// <summary>
/// Set the setting with a new setting