Skip to content
Browse files

Add a README and fix build.xml

  • Loading branch information...
1 parent 4eddc27 commit 6e1c7154005371f2cc700f08a967ec737000ea78 @bhollis committed
Showing with 40 additions and 1 deletion.
  1. +39 −0 README.md
  2. +1 −1 build.xml
View
39 README.md
@@ -0,0 +1,39 @@
+JSONView
+========
+
+[JSONView](http://jsonview.com) is a Firefox extension that helps you view JSON documents in the browser.
+
+Normally when encountering a [JSON](http://json.org) document (content type "application/json"), Firefox simply prompts you to download the view. With the JSONView extension, JSON documents are shown in the browser similar to how XML documents are shown. The document is formatted, highlighted, and arrays and objects can be collapsed. Even if the JSON document contains errors, JSONView will still show the raw text.
+
+Once you've got JSONView installed, check out [this example JSON file](http://jsonview.com/example.json) to see the extension in action!
+
+[CouchDB](http://couchdb.apache.org/) users and others who need to have "application/json" sent in the HTTP Accept header to serve JSON properly should set that option in JSONView's options panel.
+
+If you'd like to contribute to JSONView but don't want to code, consider contributing a translation. Just go to [BabelZilla](http://www.babelzilla.org/index.php?option=com_wts&Itemid=88&type=show&extension=4898) and register as a translator for the JSONView extension. There's not much there to translate!
+
+Reporting Issues
+----------------
+
+The code has moved over to GitHub, but the issues are still at Google Code for now: [JSONView issue tracker](http://code.google.com/p/jsonview/issues/list). Pull requests are welcome.
+
+Building JSONView
+-----------------
+
+* Install [ant](http://ant.apache.org/)
+* Run `ant` to produce an XPI
+
+Developing JSONView
+-------------------
+* [Set up your Firefox addon development environment](https://developer.mozilla.org/en/Setting_up_extension_development_environment)
+* Open your [Firefox profile folder](http://kb.mozillazine.org/Profile_folder)
+* Create a file called `jsonview@brh.numbera.com` and put the path to your checked out JSONView's `src` folder into it.
+* Run Firefox. You can now restart Firefox to pick up changes to JSONView in source.
+
+Unofficial Ports
+----------------
+* [jsonview-chrome](https://github.com/jamiew/jsonview-chrome)
+* [jsonview-opera](https://github.com/fearphage/jsonview-opera)
+
+
+
+JSONView is open source software under the MIT licence.
View
2 build.xml
@@ -1,4 +1,4 @@
-r<?xml version="1.0"?>
+<?xml version="1.0"?>
<project name="jsonview" default="createxpi">
<property name="build.version" value="0.6"/>
<property name="xpi.name" value="${ant.project.name}-${build.version}.xpi"/>

0 comments on commit 6e1c715

Please sign in to comment.
Something went wrong with that request. Please try again.