Rename formatters.go -> format_checkers.go. Update README example
diff --git a/README.md b/README.md
index 6c9bca1..e5f0797 100644
--- a/README.md
+++ b/README.md
@@ -202,33 +202,31 @@
%field% must be greater than or equal to %min%
```
-## Formatters
-JSON Schema allows for optional "format" property to validate strings against well-known formats. gojsonschema ships with an email format that you can use like this:
+## Formats
+JSON Schema allows for optional "format" property to validate strings against well-known formats. gojsonschema ships with all of the formats defined in the spec that you can use like this:
````json
- {"type": "string", "format": "email"}
+{"type": "string", "format": "email"}
````
-For repetitive or more complex formats, you can create custom formatters and add them to gojsonschema like this:
+Available formats: date-time, hostname, email, ipv4, ipv4, uri
+
+For repetitive or more complex formats, you can create custom format checkers and add them to gojsonschema like this:
```go
- // Define the format checker
- type URLFormatter struct {}
+// Define the format checker
+type RoleFormatChecker struct {}
- // Ensure it meets the gojsonschema.FormatChecker interface
- func (f URLFormatter) IsFormat(input string) bool {
- if _, err := URL.Parse(input); err != nil {
- return false;
- }
+// Ensure it meets the gojsonschema.FormatChecker interface
+func (f RoleFormatChecker) IsFormat(input string) bool {
+ return strings.HasPrefix("ROLE_", input)
+}
- return true
- }
-
- // Add the formatter
- gojsonschema.Formatters.Add("url", URLFormatter{})
+// Add it to the library
+gojsonschema.FormatCheckers.Add("role", RoleFormatChecker{})
````
Now to use in your json schema:
````json
- {"type": "string", "format": "url"}
+{"type": "string", "format": "role"}
````
## Uses
diff --git a/formatters.go b/format_checkers.go
similarity index 100%
rename from formatters.go
rename to format_checkers.go
