mirror of
https://github.com/sourcey/spectacle.git
synced 2024-09-11 05:25:36 +03:00
Update README
This commit is contained in:
parent
9496d350cf
commit
ccc71a2cf9
@ -1,8 +1,10 @@
|
||||
# Spectacle
|
||||
|
||||
> The gentleman at REST
|
||||
|
||||
Spectacle generates beautiful static HTML5 documentation from [OpenAPI](https://openapis.org)/[Swagger](http://swagger.io) 2.0 API specifications.
|
||||
|
||||
The goal of Spectacle is help you "save time and look good" by providing an extensible platform for generating your REST API docs. The default layout is a three column single page, similar to those
|
||||
The goal of Spectacle is help you "save time and look good" by providing an extensible platform for auto generating your REST API docs. The default layout is a three column single page, similar to those
|
||||
employed by [Stripe](https://stripe.com/docs/api) and [Intercom](https://developers.intercom.com/reference).
|
||||
|
||||
See a demo of Spectacle in action here: [http://cheesestore.github.io](http://cheesestore.github.io)
|
||||
@ -11,6 +13,8 @@ See a demo of Spectacle in action here: [http://cheesestore.github.io](http://ch
|
||||
|
||||
![Demo Screenshot](screenshot.jpg)
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
* **OpenAPI/Swagger 2.0 support**: Support for the latest OpenAPI/Swagger specification.
|
||||
|
Loading…
Reference in New Issue
Block a user