Evgenii Neumerzhitckii 11 years ago
parent
commit
634a8a1663
1 changed files with 27 additions and 1 deletions
  1. 27 1
      README.md

+ 27 - 1
README.md

@@ -1,4 +1,30 @@
-# iOS/Swift library class to write and read text to Keychain
+# iOS/Swift library for storing data in Keychain
+
+This class was written to provide a simple way of writing to and reading from a Keychain.
+
+## Installation
+
+Copy `TegKeychain.swift` into your project.
+
+## Usage
+
+```Swift
+TegKeychain.set("my key", value: "hello world")
+
+TegKeychain.getString("key 1")
+
+TegKeychain.delete("my key")
+
+TegKeychain.clear()
+```
+
+In addition to String one cart write and read `NSData` objects.
+
+```Swift
+TegKeychain.set("my key", value: nsDataObject)
+
+TegKeychain.getData("my key")
+```
 
 ### Reference