From d67f830def08e582cadcc8ecac6c56ef67bd5907 Mon Sep 17 00:00:00 2001 From: alisdair sullivan Date: Wed, 22 Sep 2010 23:06:11 -0700 Subject: [PATCH] incremented version number and added CHANGES --- CHANGES | 6 ++++++ README.markdown | 18 +++++++++++------- doc/overview.edoc | 2 +- ebin/jsx.app | 2 +- src/jsx.erl | 2 +- 5 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 CHANGES diff --git a/CHANGES b/CHANGES new file mode 100644 index 0000000..aa6b39e --- /dev/null +++ b/CHANGES @@ -0,0 +1,6 @@ +0.9.0 +===== + +* updated rebar to latest (git commit: a43381fe0bd3d6929b31) +* integrated all tests into most relevant modules, there's now no useless .beam files to pollute production code +* finalized api. no public function exports or function options will be REMOVED, though some may still be added \ No newline at end of file diff --git a/README.markdown b/README.markdown index acbee3f..2a526ee 100644 --- a/README.markdown +++ b/README.markdown @@ -1,9 +1,14 @@ -jsx -=== +jsx (v0.9.0) +============ -jsx is an event based json parser. basically [yajl][1], but in erlang. born from a need for a stream based, incremental parser capable of outputting a number of representations. see [the wiki][2] for examples of what it can do. +jsx is an event based json parser. basically [yajl][1], but in erlang. born from a need for a stream based, incremental parser capable of outputting a number of representations. see [the wiki][2] for examples of what it can do -it also includes an implementation of [eep0018][3], a pretty printer, a verifier and a few stray functions to help you write your own json gizmos. +it also includes an implementation of [eep0018][3], a pretty printer, a verifier and a few stray functions to help you write your own json gizmos + + +### i just want to encode/decode json maaaaaan ### + +`jsx:term\_to\_json` and `jsx:json\_to\_term` are what you want. see [the wiki][2] or [eep0018][3] for usage examples ### usage ### @@ -53,14 +58,13 @@ jsx is stream based and allows the parsing of naked, unwrapped json values. toge ### installation ### `make` to build jsx -`make install` to install into `code:root_dir()` ### notes ### -don't edit the various jsx\_utfx.erl files in the src dir directly, see comments in those files for why +don't edit the various jsx\_utfxx.erl files in the src dir directly, see comments in those files for why -jsx supports utf8, utf16 (little and big endian) and utf32 (little and big endian). future support is planned for erlang iolists +jsx supports utf8, utf16 (little and big endian) and utf32 (little and big endian). future support is planned for erlang iolists (maybe) diff --git a/doc/overview.edoc b/doc/overview.edoc index 81c78a3..110076d 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -1,6 +1,6 @@ @author Alisdair Sullivan @copyright 2010 Alisdair Sullivan -@version really, really beta +@version 0.9.0 @title jsx @doc jsx is a json parser with an easily transformable representation, the ability to parse streams incrementally, low memory overhead and a clean generator based interface. it also includes an implementation of eep0018, a json reformatter and a json verifier diff --git a/ebin/jsx.app b/ebin/jsx.app index 9dfe537..5e0fd88 100644 --- a/ebin/jsx.app +++ b/ebin/jsx.app @@ -1,7 +1,7 @@ {application, jsx, [ {description, "a streaming, evented json parsing toolkit"}, - {vsn, "0.8"}, + {vsn, "0.9.0"}, {modules, [ jsx, jsx_utf8, diff --git a/src/jsx.erl b/src/jsx.erl index 4febd49..563888b 100644 --- a/src/jsx.erl +++ b/src/jsx.erl @@ -23,7 +23,7 @@ %% @author Alisdair Sullivan %% @copyright 2010 Alisdair Sullivan -%% @version really, really beta +%% @version 0.9.0 %% @doc this module defines the interface to the jsx json parsing library -module(jsx).