Browse Source

Update README

Thomas Adamcik 15 years ago
parent
commit
2cfd9f3e27
1 changed files with 30 additions and 0 deletions
  1. 30 0
      README

+ 30 - 0
README

@@ -9,3 +9,33 @@ to a resolution of these issues upstream.
 In addition to the basic IPAddressField replacement a CIDR and MAC field have
 been added. Furthermore a customer Manager allows for access to all of PostgreSQL's
 INET operators.
+
+Getting started
+---------------
+
+Make sure netfields is in your PYTHONPATH, then simply use the following:
+
+ from netfields import InetAddressField, NetManager
+
+ class Example(models.Model):
+     inet = InetAddressField()
+     ...
+
+     objects = NetManager()
+
+The page also provides CidrAddressField and a MACAddressField. NetManger is
+required for the extra lookups to be available. Lookups for INET and CIDR
+database types will be handled differently than when running vanilla Django.
+All lookups are case-insensitive and text based lookups are avoided whenever
+possible. In addition to Django's default lookup types the following have been
+added.
+
+ __net_contained
+ __net_contained_or_equal
+ __net_contains
+ __net_contains_or_equals
+
+These correspond with the operators from
+http://www.postgresql.org/docs/8.3/interactive/functions-net.html
+
+netfields does not have to be in INSTALLED_APPS.