Skip to content

Commit

Permalink
Add some information in README
Browse files Browse the repository at this point in the history
  • Loading branch information
fizruk committed Dec 20, 2015
1 parent aa24f2e commit 9dd673e
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,33 @@
[![Build Status](https://travis-ci.org/GetShopTV/swagger2.svg?branch=master)](https://travis-ci.org/GetShopTV/swagger2)

Swagger 2.0 data model.

The original Swagger 2.0 specification is available at [http://swagger.io/specification/]().

## Usage

This library is inteded to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.

Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).

Some examples can be found in [`examples/` directory](/examples).

## Trying out

All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/).

Ready-to-use specification can be served as JSON and interactive API documentation
can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui).

Many Swagger tools, including server and client code generation for many languages, can be found on
[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/).

## Contributing

We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.

Please report bugs via the [github issue tracker](https://github.com/GetShopTV/swagger2/issues).

/GetShopTV Team/


0 comments on commit 9dd673e

Please sign in to comment.