Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

small work on readme

  • Loading branch information...
commit ec5d1bcc46d73393183741eb40f04bc92bcbea83 1 parent a6c9432
@jwhitehorn authored
Showing with 10 additions and 1 deletion.
  1. +10 −1 README.markdown
View
11 README.markdown
@@ -15,4 +15,13 @@ Released under the terms of the associated [license](https://github.com/jwhiteho
Getting Started
========
-To use this library you will also need to reference the libsqlite3.0.dylib library.
+To use this library you will need to reference the libsqlite3.0.dylib library. After you've referenced that, simply add the files SKDatabase.h and SKDatabase.m to your project. I recommend creating a folder, and an appropriate group in Xcode, called SKDatabase to store those files in.
+
+Using SKDatabase
+========
+
+The core of SKDatabase (and frankly the _only_ of SKDatabase) is the SKDatabase class. This class represents your connection to a SQLite database. To initialize your database connection use one of the following:
+
+- (id)initWithFile:(NSString *)dbFile;
+- (id)initWithReadOnlyFile:(NSString *)dbFile;
+- (id)initWithData:(NSData *)data andFile:(NSString *)dbFile;
Please sign in to comment.
Something went wrong with that request. Please try again.