[Python-modules-commits] [python-pyld] 130/276: Use reST vs markdown for README.

Wed Oct 8 23:48:01 UTC 2014

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

debacle pushed a commit to branch master
in repository python-pyld.

commit d9fef6940fd0bd6339123748f225acc7acc37a1d
Author: David I. Lehn <dlehn at digitalbazaar.com>
Date:   Mon Jun 17 14:08:50 2013 -0400

    Use reST vs markdown for README.
    
    Using reStructuredText makes it easier to share README text with Python
    packaging tools.
---
 README.md  | 69 -----------------------------------------------------------
 README.rst | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+), 69 deletions(-)

diff --git a/README.md b/README.md
deleted file mode 100644
index 73c50bd..0000000
--- a/README.md
+++ /dev/null
@@ -1,69 +0,0 @@
-Introduction
-------------
-
-JSON, as specified in RFC4627, 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.
-
-This library is an implementation of the [JSON-LD] specification
-in [Python].
-
-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 [RDFA-CORE] data,
-Microformats [MICROFORMATS] data, and Microdata [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.
-
-Commercial Support
-------------------
-
-Commercial support for this library is available upon request from 
-Digital Bazaar: support at digitalbazaar.com
-
-Requirements
-------------
-
- * [Python][] (2.5 or later)
-
-Source
-------
-
-The source code for the Python implementation of the JSON-LD API
-is available at:
-
-http://github.com/digitalbazaar/pyld
-
-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 repository][json-ld.org] hosted on GitHub.
-
-https://github.com/json-ld/json-ld.org
-
-Then run the jsonld-tests.php application and point it at the directory
-containing the tests.
-
-    python tests/runtests.py -d {PATH_TO_JSON_LD_ORG/test-suite/tests}
-
-[Python]: http://www.python.org/
-[JSON-LD]: http://json-ld.org/
-[json-ld.org]: https://github.com/json-ld/json-ld.org
-
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..1b75ec5
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,72 @@
+Introduction
+------------
+
+This library is an implementation of the JSON-LD_ specification in Python_.
+
+JSON, as specified in RFC4627_, 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.
+
+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.
+
+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.
+
+Commercial Support
+------------------
+
+Commercial support for this library is available upon request from
+`Digital Bazaar`_: support at digitalbazaar.com.
+
+Requirements
+------------
+
+- Python_ (2.5 or later)
+
+Source
+------
+
+The source code for the Python implementation of the JSON-LD API is
+available at:
+
+http://github.com/digitalbazaar/pyld
+
+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:
+
+https://github.com/json-ld/json-ld.org
+
+Then run the jsonld-tests.php application and point it at the directory
+containing the tests.
+
+::
+
+    python tests/runtests.py -d {PATH_TO_JSON_LD_ORG/test-suite/tests}
+
+.. _JSON-LD: http://json-ld.org/
+.. _Python: http://www.python.org/
+.. _Digital Bazaar: http://digitalbazaar.com/
+.. _RDFa: http://www.w3.org/TR/rdfa-core/
+.. _Microformats: http://microformats.org/
+.. _Microdata: http://www.w3.org/TR/microdata/
+.. _RFC4627: http://www.ietf.org/rfc/rfc4627.txt

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

