Skip to content

Commit

Permalink
Minor README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
iay committed Jul 13, 2018
1 parent a7f26ee commit a2d24f1
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ recent formally submitted Internet Draft.

## Terminology

Please don't use the term "MDX" to refer to this specification or the protocol specified by it. "MDX" as an acronym for MetaData eXchange refers to a more general concept of which the Metadata Query Protocol is just one component.
Please don't use the term "MDX" to refer to this specification or the protocol
specified by it. "MDX" as an acronym for MetaData eXchange refers to a more
general concept of which the Metadata Query Protocol is just one component.

If you need to refer to this specification, md-query or even MDQ is more appropriate.
If you need to refer to this specification, "md-query" or even "MDQ" is more
appropriate.

## Implementations

The following software is believed to be compatible with the requester (client) role described in the current draft:
The following software is believed to be compatible with the requester (client)
role described in the current draft:

* [Shibboleth Identity Provider][IdP], v3.0.0 or later:
* [configuration details][IdPConfig]
Expand All @@ -36,7 +40,8 @@ The following software is believed to be compatible with the requester (client)
* [SimpleSAMLphp][SSP], v1.14.0 or later:
* [pull request](https://github.com/simplesamlphp/simplesamlphp/pull/146)

The following software is believed to be compatible with the responder (server) role described in the current draft:
The following software is believed to be compatible with the responder (server)
role described in the current draft:

* [mdq-server][] is a Java implementation based on [Spring Boot][Boot] and the [Shibboleth Metadata Aggregator][MDA]:
* Configuration examples can be found in the accompanying [mdq-server-docker][] project.
Expand Down Expand Up @@ -90,8 +95,8 @@ requirements are:
* metadata format agnostic — we started with SAML metadata but it shouldn't be the only format we support
* good net citizen — we need to work well with proxies, caching infrastructure, etc.

The chosen route has been to define the query protocol as a RESTian web service
running over HTTP.
The chosen route has been to define the query protocol as a REST-like web
service running over HTTP.

## Building the Documents

Expand All @@ -101,6 +106,6 @@ The repository always includes that form plus `.txt` versions rendered from the
XML.

I'm using the included `Makefile` to build the HTML and text forms of the
document. This requires a locally installed copy of version 2.x of the
document. This requires a locally installed copy of version 2.9.x of the
[`xml2rfc` tool](https://pypi.python.org/pypi/xml2rfc/). An
[online version](http://xml.resource.org) of `xml2rfc` is also available.

0 comments on commit a2d24f1

Please sign in to comment.