Added installation instructions to the README.

[invirt/packages/python-jsonrpclib.git] / README

diff --git a/README b/README
index 5f975ba..0d47203 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,23 @@
- Copyright [2009] [Josh Marshall] 
- 
- Licensed under the Apache License, Version 2.0 (the "License"); 
- you may not use this file except in compliance with the License. 
- You may obtain a copy of the License at
- 
-     http://www.apache.org/licenses/LICENSE-2.0 
- 
- Unless required by applicable law or agreed to in writing, 
- software distributed under the License is distributed on an 
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
- either express or implied. See the License for the specific 
- language governing permissions and limitations under the License. 
+JSONRPClib
+==========
+This library is an implementation of the JSON-RPC specification.
+It supports both the original 1.0 specification, as well as the 
+new (proposed) 2.0 spec, which includes batch submission, keyword
+arguments, etc.
+
+It is licensed under the Apache License, Version 2.0
+(http://www.apache.org/licenses/LICENSE-2.0.html).
+
+Installation
+============
+To install:
+
+    python setup.py build
+    sudo python setup.py install
+
+To use this module, you'll need a JSON library. The library
+looks first for cjson, then for the built-in JSON library (with
+default Python 2.6+ distributions), and finally the simplejson
+library.
+
+