Skip to content

Commit

Permalink
Added overview section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
trscavo committed Oct 13, 2016
1 parent 2418cd1 commit b5b1626
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,35 @@ $ ./install.sh $BIN_DIR $LIB_DIR

An installation directory will be created if it doesn't already exist.

## Overview

Bash script ``http_xsltproc.sh`` is a wrapper around the ``xsltproc`` command-line tool. Unlike ``xsltproc``, this script fetches the target XML document from an HTTP server. See the inline help file for details:

```Shell
$ http_xsltproc.sh -h
```

Here's an example:

```Shell
$ MD_LOCATION=http://md.incommon.org/InCommon/InCommon-metadata.xml
$ $BIN_DIR/http_xsltproc.sh $LIB_DIR/list_all_IdP_DisplayNames_csv.xsl $MD_LOCATION | head
IdP Display Name,IdP Entity ID,IdP Discovery,Registrar ID
"Ohio State University",urn:mace:incommon:osu.edu,show,https://incommon.org
"Cornell University",https://shibidp.cit.cornell.edu/idp/shibboleth,show,https://incommon.org
"University of California - Office of the President",urn:mace:incommon:ucop.edu,show,https://incommon.org
"University of California-Irvine",urn:mace:incommon:uci.edu,show,https://incommon.org
"University of Washington",urn:mace:incommon:washington.edu,show,https://incommon.org
"Internet2",urn:mace:incommon:internet2.edu,show,https://incommon.org
"University of California-San Diego",urn:mace:incommon:ucsd.edu,show,https://incommon.org
"Georgetown University",https://shibb-idp.georgetown.edu/idp/shibboleth,show,https://incommon.org
"Case Western Reserve University",urn:mace:incommon:case.edu,show,https://incommon.org
```

## Compatibility

These scripts are compatible with GNU/Linux and Mac OS.
The executable scripts are compatible with GNU/Linux and Mac OS. The library files are written XSLT 1.0.

## Dependencies

None
* [Bash Library](https://github.internet2.edu/InCommon/bash-library)

0 comments on commit b5b1626

Please sign in to comment.