incremented version number and added CHANGES

This commit is contained in:
alisdair sullivan 2010-09-22 23:06:11 -07:00
parent eebdee1eba
commit d67f830def
5 changed files with 20 additions and 10 deletions

6
CHANGES Normal file
View file

@ -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

View file

@ -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 ### ### usage ###
@ -53,14 +58,13 @@ jsx is stream based and allows the parsing of naked, unwrapped json values. toge
### installation ### ### installation ###
`make` to build jsx `make` to build jsx
`make install` to install into `code:root_dir()`
### notes ### ### 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)

View file

@ -1,6 +1,6 @@
@author Alisdair Sullivan <alisdairsullivan@yahoo.ca> @author Alisdair Sullivan <alisdairsullivan@yahoo.ca>
@copyright 2010 Alisdair Sullivan @copyright 2010 Alisdair Sullivan
@version really, really beta @version 0.9.0
@title jsx @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 <a href="http://www.erlang.org/eeps/eep-0018.html">eep0018</a>, a json reformatter and a json verifier @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 <a href="http://www.erlang.org/eeps/eep-0018.html">eep0018</a>, a json reformatter and a json verifier

View file

@ -1,7 +1,7 @@
{application, jsx, {application, jsx,
[ [
{description, "a streaming, evented json parsing toolkit"}, {description, "a streaming, evented json parsing toolkit"},
{vsn, "0.8"}, {vsn, "0.9.0"},
{modules, [ {modules, [
jsx, jsx,
jsx_utf8, jsx_utf8,

View file

@ -23,7 +23,7 @@
%% @author Alisdair Sullivan <alisdairsullivan@yahoo.ca> %% @author Alisdair Sullivan <alisdairsullivan@yahoo.ca>
%% @copyright 2010 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 %% @doc this module defines the interface to the jsx json parsing library
-module(jsx). -module(jsx).