git.iko.soy/typeable/swagger2
on master help sign in
Add some information in README
commitfef18953519fa559d9b034e8483468fed01243df authorNickolay Kudasov <nickolay.kudasov@gmail.com> dateSun 20 Dec 2015, 14:23 (11 years ago) parentaa24f2e
1 file changed+29
README.md+29
README.md+29
@@ -4,3 +4,32 @@
44[![Build Status](https://travis-ci.org/GetShopTV/swagger2.svg?branch=master)](https://travis-ci.org/GetShopTV/swagger2)
55
66Swagger 2.0 data model.
7+
8+The original Swagger 2.0 specification is available at http://swagger.io/specification/.
9+
10+## Usage
11+
12+This library is inteded to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.
13+
14+Please refer to [haddock documentation](http://hackage.haskell.org/package/swagger2).
15+
16+Some examples can be found in [`examples/` directory](/examples).
17+
18+## Trying out
19+
20+All generated swagger specifications can be interactively viewed on [Swagger Editor](http://editor.swagger.io/).
21+
22+Ready-to-use specification can be served as JSON and interactive API documentation
23+can be displayed using [Swagger UI](https://github.com/swagger-api/swagger-ui).
24+
25+Many Swagger tools, including server and client code generation for many languages, can be found on
26+[Swagger's Tools and Integrations page](http://swagger.io/open-source-integrations/).
27+
28+## Contributing
29+
30+We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.
31+
32+Please report bugs via the [github issue tracker](https://github.com/GetShopTV/swagger2/issues).
33+
34+*GetShopTV Team*
35+