From 105166f18309be22f124153dadcf4d9191230347 Mon Sep 17 00:00:00 2001 From: Nicolas Bonnel Date: Thu, 23 Feb 2017 18:55:18 +0100 Subject: [PATCH] refactor: prepare first release --- .npmignore | 4 ++++ README.md | 15 +++++++++++++-- package.json | 4 ++-- app.js => test/app.js | 0 index.html => test/index.html | 0 petstore.json => test/petstore.json | 0 webpack.config.js | 4 ++-- 7 files changed, 21 insertions(+), 6 deletions(-) create mode 100644 .npmignore rename app.js => test/app.js (100%) rename index.html => test/index.html (100%) rename petstore.json => test/petstore.json (100%) diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..c4351bc --- /dev/null +++ b/.npmignore @@ -0,0 +1,4 @@ +/node_modules +/test +yarn.lock +webpack.config.js diff --git a/README.md b/README.md index 70238c8..704933e 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 68d38a0..65d0e89 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vue-openapi", - "version": "0.0.0", + "version": "0.1.0", "description": "", "main": "OpenAPI.vue", "scripts": { @@ -8,7 +8,7 @@ "test": "echo \"Error: no test specified\" && exit 1" }, "author": "", - "license": "ISC", + "license": "MIT", "devDependencies": { "babel-core": "^6.18.2", "babel-eslint": "^7.1.1", diff --git a/app.js b/test/app.js similarity index 100% rename from app.js rename to test/app.js diff --git a/index.html b/test/index.html similarity index 100% rename from index.html rename to test/index.html diff --git a/petstore.json b/test/petstore.json similarity index 100% rename from petstore.json rename to test/petstore.json diff --git a/webpack.config.js b/webpack.config.js index 5b12a97..b3e9997 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -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' },