diff options
author | Mike Anchor <git@mjpa.co.uk> | 2013-09-26 16:07:30 +0400 |
---|---|---|
committer | Mike Anchor <git@mjpa.co.uk> | 2013-09-26 16:07:30 +0400 |
commit | 62427f3f3facde5c76d8418576c3a648dbe6458e (patch) | |
tree | 2c828fd681b80cb2c8c839d15fc16f36c18534b2 /README.md | |
parent | 8be9fa4fd77b83b6b672ea9d604013cec998a1a6 (diff) |
Rename README to README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..945abc1 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +SimpleJSON is a simple JSON library written in C++. It is designed to be simple +to use and be cross platform. + +The library consists of 2 classes - JSON and JSONValue. The JSON class acts +similar to the Javascript JSON object and contains Parse() and Stringify() +methods for dealing with decoding and encoding JSON text. The JSONValue class +is the class that deals with representing the various JSON values in a C++ way. + +Included with the source code is a demo application to give a basic example of +how the library works and run some tests on the library. Linux users should +just need the basic development tools installed while Windows will need VS2008 +to build the project (or be able to handle VS2008 project files). + +The library requires no 3rd party libraries and so can be dropped into any +existing project effortlessly. It has been tested on Linux and Windows +(using VS2008), if you come across any issues with using it on any system, feel +free to contact me by visiting my site at http://mjpa.co.uk |