Metadata-Version: 2.1
Name: adr-viewer
Version: 1.2.0
Summary: A visualisation tool for Architecture Decision Records
Home-page: https://github.com/mrwilson/adr-viewer
Author: Alex Wilson
Author-email: a.wilson@alumni.warwick.ac.uk
License: MIT
Description: # adr-viewer
        
        [![Build Status](https://travis-ci.org/mrwilson/adr-viewer.svg?branch=master)](https://travis-ci.org/mrwilson/adr-viewer)
        
        Show off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content.
        
        ## Examples
        
        <img src="images/example.png" height="500px"/>
        
        * Example above using Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools) project
        * This project exposes its own Architecture Decision Records [here](https://mrwilson.github.io/adr-viewer/index.html)
        
        ## Installation
        
        ### From PyPI
        
        ```bash
        $ pip install adr-viewer
        ```
        
        ### From local build
        
        adr-viewer requires Python 2.7 (with Pip)
        
        ```bash
        $ git clone https://github.com/mrwilson/adr-viewer
        $ pip install -r requirements.txt
        $ python setup.py install
        ```
        
        ## Usage
        
        ```bash
        Usage: adr-viewer [OPTIONS]
        
        Options:
          --adr-path TEXT  Directory containing ADR files.  [default: doc/adr/]
          --output TEXT    File to write output to.  [default: index.html]
          --serve          Serve content at http://localhost:8000/
          --help           Show this message and exit.
        ```
        
        The default for `--adr-path` is `doc/adr/` because this is the default path generated by `adr-tools`.
        
        ## Supported Record Types
        
        <img src="images/record_types.png"/>
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
