[Python-modules-commits] [python-pyld] 02/05: README sync and minor updates.

[Wolfgang Borgert]

This is an automated email from the git hooks/post-receive script.

debacle pushed a commit to tag 0.6.7
in repository python-pyld.

commit a26ad2b4af5958ff3d0e3eb57c8b42366b33af58
Author: David I. Lehn <dlehn at digitalbazaar.com>
Date:   Fri Dec 5 16:46:31 2014 -0500

    README sync and minor updates.
    
    - Sync README between Digital Bazaar JSON-LD libs.
    - Minor updates and formatting fixes.
---
 README.rst | 64 +++++++++++++++++++++++++++++++++-----------------------------
 1 file changed, 34 insertions(+), 30 deletions(-)

diff --git a/README.rst b/README.rst
index f990eba..595bb5e 100644
--- a/README.rst
+++ b/README.rst
@@ -10,31 +10,37 @@ Introduction
 
 This library is an implementation of the JSON-LD_ specification in Python_.
 
-JSON, as specified in RFC4627_, is a simple language for representing
+JSON, as specified in RFC7159_, is a simple language for representing
 objects on the Web. Linked Data is a way of describing content across
-different documents or Web sites. Web resources are described using IRIs,
-and typically are dereferencable entities that may be used to find more
-information, creating a "Web of Knowledge". JSON-LD is intended to be a
-simple publishing method for expressing not only Linked Data in JSON, but
-for adding semantics to existing JSON.
+different documents or Web sites. Web resources are described using
+IRIs, and typically are dereferencable entities that may be used to find
+more information, creating a "Web of Knowledge". JSON-LD_ is intended
+to be a simple publishing method for expressing not only Linked Data in
+JSON, but for adding semantics to existing JSON.
 
 JSON-LD is designed as a light-weight syntax that can be used to express
-Linked Data. It is primarily intended to be a way to express Linked Data in
-Javascript and other Web-based programming environments. It is also useful
-when building interoperable Web Services and when storing Linked Data in
-JSON-based document storage engines. It is practical and designed to be as
-simple as possible, utilizing the large number of JSON parsers and existing
-code that is in use today. It is designed to be able to express key-value
-pairs, RDF data, RDFa_ data, Microformats_ data, and Microdata_. That is, it
-supports every major Web-based structured data model in use today.
+Linked Data. It is primarily intended to be a way to express Linked Data
+in JavaScript and other Web-based programming environments. It is also
+useful when building interoperable Web Services and when storing Linked
+Data in JSON-based document storage engines. It is practical and
+designed to be as simple as possible, utilizing the large number of JSON
+parsers and existing code that is in use today. It is designed to be
+able to express key-value pairs, RDF data, RDFa_ data,
+Microformats_ data, and Microdata_. That is, it supports every
+major Web-based structured data model in use today.
 
 The syntax does not require many applications to change their JSON, but
 easily add meaning by adding context in a way that is either in-band or
-out-of-band. The syntax is designed to not disturb already deployed systems
-running on JSON, but provide a smooth migration path from JSON to JSON with
-added semantics. Finally, the format is intended to be fast to parse, fast
-to generate, stream-based and document-based processing compatible, and
-require a very small memory footprint in order to operate.
+out-of-band. The syntax is designed to not disturb already deployed
+systems running on JSON, but provide a smooth migration path from JSON
+to JSON with added semantics. Finally, the format is intended to be fast
+to parse, fast to generate, stream-based and document-based processing
+compatible, and require a very small memory footprint in order to operate.
+
+Requirements
+------------
+
+- Python_ (2.7 or later)
 
 Installation
 ------------
@@ -43,7 +49,7 @@ PyLD can be installed with pip_:
 
 .. code-block:: bash
 
-    $ pip install PyLD
+    pip install PyLD
 
 Quick Examples
 --------------
@@ -116,24 +122,22 @@ Commercial Support
 Commercial support for this library is available upon request from
 `Digital Bazaar`_: support at digitalbazaar.com.
 
-Requirements
-------------
-
-- Python_ (2.7 or later)
-
 Source
 ------
 
-The source code for the Python implementation of the JSON-LD API is
-available at:
+The source code for the Python implementation of the JSON-LD API
+is available at:
 
 http://github.com/digitalbazaar/pyld
 
+Tests
+-----
+
 This library includes a sample testing utility which may be used to verify
 that changes to the processor maintain the correct output.
 
 To run the sample tests you will need to get the test suite files by cloning
-the ``json-ld.org`` hosted on GitHub:
+the ``json-ld.org`` repository hosted on GitHub:
 
 https://github.com/json-ld/json-ld.org
 
@@ -141,7 +145,7 @@ Then run the test application using the directory containing the tests:
 
 .. code-block:: bash
 
-    $ python tests/runtests.py -d {PATH_TO_JSON_LD_ORG/test-suite}
+    python tests/runtests.py -d {PATH_TO_JSON_LD_ORG/test-suite}
 
 .. _Digital Bazaar: http://digitalbazaar.com/
 .. _JSON-LD: http://json-ld.org/
@@ -149,5 +153,5 @@ Then run the test application using the directory containing the tests:
 .. _Microformats: http://microformats.org/
 .. _Python: http://www.python.org/
 .. _RDFa: http://www.w3.org/TR/rdfa-core/
-.. _RFC4627: http://www.ietf.org/rfc/rfc4627.txt
+.. _RFC7159: http://tools.ietf.org/html/rfc7159
 .. _pip: http://www.pip-installer.org/

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-pyld.git