From 4160dc4e65dc4c5c8ba2f2245512586490072f60 Mon Sep 17 00:00:00 2001 From: Brian Waldon Date: Fri, 1 Jun 2012 14:34:50 -0700 Subject: Renaming README to README.md --- README | 27 --------------------------- README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 27 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 760fd12..0000000 --- a/README +++ /dev/null @@ -1,27 +0,0 @@ -# Warlock! - -1) Create a class - - import warlock - - schema = { - 'name': 'Country': - 'properties': { - 'name': {'type': 'string'}, - 'abbreviation': {'type': 'string'}, - }, - } - - Country = warlock.schema_class(schema) - -2) Create an object using your class - - sweden = Country(name='Sweden', abbreviation='SE') - -3) Let the object validate itself! - - sweden.name = 5 - # Raises ValueError - - sweden.overlord = 'Brian' - # Raises AttributeError diff --git a/README.md b/README.md new file mode 100644 index 0000000..760fd12 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Warlock! + +1) Create a class + + import warlock + + schema = { + 'name': 'Country': + 'properties': { + 'name': {'type': 'string'}, + 'abbreviation': {'type': 'string'}, + }, + } + + Country = warlock.schema_class(schema) + +2) Create an object using your class + + sweden = Country(name='Sweden', abbreviation='SE') + +3) Let the object validate itself! + + sweden.name = 5 + # Raises ValueError + + sweden.overlord = 'Brian' + # Raises AttributeError -- cgit v1.2.1