Skip to content

Commit 4160f98

Browse files
committed
clarify Key is a string in README.md re #50
1 parent ac5f8c6 commit 4160f98

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ There are two ways of using jesse:
5555
```erlang
5656
1> Schema = jiffy:decode(<<"{\"items\": {\"type\": \"integer\"}}">>).
5757
{[{<<"items">>,{[{<<"type">>,<<"integer">>}]}}]}
58-
2> jesse:add_schema(some_key, Schema).
58+
2> jesse:add_schema("some_key", Schema).
5959
ok
6060
3> Json1 = jiffy:decode(<<"[1, 2, 3]">>).
6161
[1,2,3]
62-
4> jesse:validate(some_key, Json1).
62+
4> jesse:validate("some_key", Json1).
6363
{ok,[1,2,3]}
6464
5> Json2 = jiffy:decode(<<"[1, \"x\"]">>).
6565
[1,<<"x">>]
66-
6> jesse:validate(some_key, Json2).
66+
6> jesse:validate("some_key", Json2).
6767
{error,[{data_invalid,{[{<<"type">>,<<"integer">>}]},
6868
wrong_type,<<"x">>,
6969
[1]}]}
@@ -75,15 +75,15 @@ validation failed. See *Validation errors* below for the full error format.
7575
(using a callback)
7676

7777
```erlang
78-
1> jesse:add_schema(some_key,
78+
1> jesse:add_schema("some_key",
7979
1> <<"{\"uniqueItems\": true}">>,
8080
1> [{parser_fun, fun jiffy:decode/1}]).
8181
ok
82-
2> jesse:validate(some_key,
82+
2> jesse:validate("some_key",
8383
2> <<"[1, 2]">>,
8484
2> [{parser_fun, fun jiffy:decode/1}]).
8585
{ok,[1, 2]}
86-
3> jesse:validate(some_key,
86+
3> jesse:validate("some_key",
8787
3> <<"[{\"foo\": \"bar\"}, {\"foo\": \"bar\"}] ">>,
8888
3> [{parser_fun, fun jiffy:decode/1}]).
8989
{error,[{data_invalid,{[{<<"uniqueItems">>,true}]},

0 commit comments

Comments
 (0)