umgeher/jsx
0
Fork 0
Code Issues Pull requests Activity

remove unsightly indentation from quickstart examples

Browse source
This commit is contained in:
alisdair sullivan 2012-05-17 23:07:09 -07:00
parent a2929c3108
commit d0fad06d1f
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.markdown
View file

@ -33,47 +33,47 @@ jsx uses [sinan][sinan] or [rebar][rebar] for it's build chain
to build the library
```bash
tanga:jsx alisdair$ sinan build
tanga:jsx alisdair$ sinan build
```
or
```bash
tanga:jsx alisdair$ rebar compile
tanga:jsx alisdair$ rebar compile
```
to run tests
```bash
tanga:jsx alisdair$ sinan -r tests eunit
tanga:jsx alisdair$ sinan -r tests eunit
```
or
```bash
tanga:jsx alisdair$ rebar eunit
tanga:jsx alisdair$ rebar eunit
```
to convert a utf8 binary containing a json string into an erlang term
```erlang
1> jsx:to_term(<<"{\"library\": \"jsx\", \"awesome\": true}">>).
[{<<"library">>,<<"jsx">>},{<<"awesome">>,true}]
1> jsx:to_term(<<"{\"library\": \"jsx\", \"awesome\": true}">>).
[{<<"library">>,<<"jsx">>},{<<"awesome">>,true}]
```
to convert an erlang term into a utf8 binary containing a json string
```erlang
1> jsx:to_json([<<"a">>, <<"list">>, <<"of">>, <<"words">>]).
<<"[\"a\",\"list\",\"of\",\"words\"]">>
1> jsx:to_json([<<"a">>, <<"list">>, <<"of">>, <<"words">>]).
<<"[\"a\",\"list\",\"of\",\"words\"]">>
```
to check if a binary or a term is valid json
```erlang
1> jsx:is_json(<<"[1]">>).
true
2> jsx:is_term(1).
true
1> jsx:is_json(<<"[1]">>).
true
2> jsx:is_term(1).
true
```