fix: setup travis deployment

Author: Ben Force

.circleci/config.yml

@@ -8,4 +8,5 @@ examples
 .gitignore
 make-examples.js
 .vscode
-.circleci
+.circleci
+.travis.yml

.npmignore

@@ -0,0 +1,17 @@
+language: node_js
+node_js: "11"
+
+cache: yarn
+
+jobs:
+  include:
+    # Define the release stage that runs semantic-release
+    - stage: release
+      if: branch = master
+      node_js: lts/*
+      # Advanced: optionally overwrite your default `script` step to skip the tests
+      # script: skip
+      deploy:
+        provider: script
+        skip_cleanup: true
+        script: yarn semantic-release --allow-same-version

.travis.yml

@@ -1,65 +1,57 @@
-swagger-markdown
-================
+# openapi-markdown
 
-[![npm][npm-image]][npm-url] [![dependencies][david-image]][david-url] [![circle ci][circleci-image]][circleci-url]
+[![npm][npm-image]][npm-url]
 
-CLI script to turn swagger yaml into markdown files.
-Supports swagger 2.0 format only
-
-see [examples](https://github.com/syroegkin/swagger-markdown/tree/master/examples) folder
+CLI script to turn swagger/OpenAPI yaml into markdown files.
+Primarily supports swagger 2.0, with some OpenAPI 3.0 features.
 
 ### Installation
 
-    npm install -g swagger-markdown
+    npm install -g openapi-markdown
 
 ### Usage
 
 ```
-swagger-markdown [-h] [-v] -i [-o] [--skip-info]
+openapi-markdown [-h] [-v] -i [-o] [--skip-info]
 
 Options:
   -h, --help      Show this help message and exit.
   -v, --version   Show program's version number and exit.
-  -i , --input    Path to the swagger yaml file
+  -i , --input    Path to the openapi yaml file
   -o , --output   Path to the resulting md file
   --skip-info     Skip the title, description, version etc, whatever is in the info block.
 
 ```
 
 ### Npx (requires no installation)
+
 ```
-npx swagger-markdown -i ./basic-auth.yaml
+npx openapi-markdown -i ./basic-auth.yaml
 ```
 
 #### Example:
 
 ```javascript
-swagger-markdown -i path/to/swagger/file.yaml
+openapi-markdown -i path/to/openapi/file.yaml
 ```
-By default it will create the new file within the same directory with the same name as swagger file but with .md extension.
-So, if swagger file is placed in `project/api-doc/swagger.yaml` the new file will be created as `project/api-doc/swagger.md`
+
+By default it will create the new file within the same directory with the same name as openapi file but with .md extension.
+So, if openapi file is placed in `project/api-doc/openapi.yaml` the new file will be created as `project/api-doc/openapi.md`
 
 You can also use it as a npm script in your package.json:
 
-    npm i --save-dev swagger-markdown
+    npm i --save-dev openapi-markdown
 
 ```jsonc
 {
-    "scripts": {
-        "md-docs": "swagger-markdown -i path/to/swagger.yaml",
-        //...
-    }
+  "scripts": {
+    "md-docs": "openapi-markdown -i path/to/openapi.yaml"
+    //...
+  }
 }
 ```
 
     npm run md-docs
 
-[npm-url]: https://www.npmjs.com/package/swagger-markdown
-[npm-image]: https://img.shields.io/npm/v/swagger-markdown.svg
-
-[david-url]: https://david-dm.org/syroegkin/swagger-markdown
-[david-image]: https://img.shields.io/david/syroegkin/swagger-markdown.svg
-
-[circleci-url]: https://circleci.com/gh/syroegkin/swagger-markdown/tree/master
-[circleci-image]: https://img.shields.io/circleci/project/syroegkin/swagger-markdown.svg
-
+[npm-url]: https://www.npmjs.com/package/openapi-markdown
+[npm-image]: https://img.shields.io/npm/v/openapi-markdown.svg

CHANGELOG.md

@@ -1,14 +1,15 @@
 {
-  "name": "swagger-markdown",
+  "name": "openapi-markdown",
   "version": "1.2.0",
-  "description": "Create markdown API documentation from swagger file",
+  "description": "Create markdown API documentation from swagger/openapi files",
   "main": "index.js",
   "scripts": {
     "test": "npm run test:app && npm run test:lint",
     "test:app": "mocha \"tests/**/*.spec.js\"",
     "test:watch": "mocha --watch \"tests/**/*.spec.js\"",
     "test:lint": "eslint .",
     "build": "babel app --out-dir bin",
+    "prepare": "npm run build",
     "prepublish": "npm run build",
     "commit": "git-cz",
     "semantic-release": "semantic-release"