0
@@ -22,6 +22,21 @@ mapping information. It is kindly provided free of charge by MaxMind.com.
0
    #     :area_code=>607, 
0
    #     :region=>"NY" }
0
 
0
+There are two optional arguments to database initializer.
0
+The first argument is the filename of the GeoIPCity.dat file 
0
+The second argument (optional) is to specify how GeoIP should
0
+keep the database in memory. There are three possibilities
0
+* :filesystem -- read database from filesystem, uses least memory.
0
+* :index -- the most frequently accessed index portion of the database, resulting in faster lookups than :filesystem, but less memory usage than :memory.
0
+* :memory -- load database into memory, faster performance but uses more memory.
0
+  (default)
0
+
0
+The third argument is boolean and decides whether the system should reload the database if changes are made to the dat file. (You probably don't need this. Default: false.)
0
+
0
+For example 
0
+
0
+  GeoIPCity::Database.new(dbfile, :filesystem, true)
0
+
0
 = Install
0
 Some variation of the following should work.
0
 
0
@@ -44,7 +59,6 @@ Some variation of the following should work.
0
    I put this file in 
0
    /opt/GeoIP/share/GeoIP/GeoLiteCity.dat
0
 
0
-
0
 4. Use it!
0
 
0
 = License