Initial commit.

README.md

@@ -1,2 +1,49 @@
-# PreferenceStore
-A customized preference store library for android with compilte-time type checking and a lot more.
+# AndroidZip [![](https://jitpack.io/v/buggysofts-com/PreferenceStore.svg)](https://jitpack.io/#buggysofts-com/PreferenceStore)
+A customized preference store library for android with compile-time type checking and a lot more.
+
+<br />
+
+## Import
+Add JitPack repository to your project level build.gradle file
+```
+...
+
+allprojects {
+    repositories {
+        ...
+        maven { url 'https://jitpack.io' }
+    }
+}
+```
+Or, in newer android projects, if you need to add the repository in settings.gradle file...
+```
+...
+
+dependencyResolutionManagement {
+    ...
+    repositories {
+        ...
+        maven { url 'https://jitpack.io' }
+    }
+}
+```
+Finally, add these two dependencies to your app/module level build.gradle file
+```
+...
+
+dependencies {
+    ...
+    implementation 'com.google.code.gson:gson:2.9.1'
+    implementation 'com.github.buggysofts-com:PreferenceStore:v1.0.0'
+}
+```
+And you are done importing the library.
+
+<br />
+
+## Sample codes
+Upcoming...
+
+Please share & rate the library if you find it useful.
+
+### Happy coding!