Skip to content

Commit

Permalink
refactor: prepare first release
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolas-bonnel committed Feb 23, 2017
1 parent cb18d4d commit 105166f
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/node_modules
/test
yarn.lock
webpack.config.js
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# OpenAPI viewer component for VueJS

This [Vue.js](https://vuejs.org/) component is designed to easily browse and test a REST API described
with the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) (formerly known as Swagger Specification). This component follows Google [Material Design](https://material.google.com/) principles and relies on the [Vue Material](https://github.com/marcosmoura/vue-material) framework.
with the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) (formerly known as Swagger Specification). This component follows Google [Material Design](https://material.google.com/) principles and relies on the [Vue Material](https://github.com/marcosmoura/vue-material) framework. It also relies on [vue-resource](https://github.com/pagekit/vue-resource) to perform API requests.

See it in action :
* https://koumoul.com/s/geocoder/api-doc

## Install

TODO (no npm built yet)
npm :
```
npm install --save vue-openapi
```

yarn:
```
yarn add vue-openapi
```

## Usage

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "vue-openapi",
"version": "0.0.0",
"version": "0.1.0",
"description": "",
"main": "OpenAPI.vue",
"scripts": {
"dev": "NODE_ENV=development webpack --watch",
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"license": "MIT",
"devDependencies": {
"babel-core": "^6.18.2",
"babel-eslint": "^7.1.1",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions webpack.config.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
var webpack = require('webpack')

module.exports = {
entry: './app.js',
entry: './test/app.js',
output: {
filename: 'bundle.js',
path: './',
path: './test/',
publicPath: '/',
chunkFilename: '[id].[hash].app.js'
},
Expand Down

0 comments on commit 105166f

Please sign in to comment.