Final fixes

Author: RomanHotsiy

README.md

@@ -1,9 +1,12 @@
-# create-openapi-repo [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
-> Generator for OpenAPI(fka Swagger) repository
+# create-openapi-repo
+
+[![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]
+
+> Generator for OpenAPI repository
 
 <center>
 
-![logo](./logo.png)
+<img src="./logo.png" widht="500px"/>
 
 </center>
 
@@ -17,11 +20,11 @@ There are a few advantages in hosting your API specification + docs on GitHub:
 
 ## Features
 This generator helps to create a GitHub repo with the following features:
- - Possibility to split a big Swagger spec into smaller files and bundle it for deployment
+ - Possibility to split a big OpenAPI spec into smaller files and bundle it for deployment
  - Continuous integration/deployment on Travis
  - Code samples as separate files
- - Swagger spec is validated after each commit
- - Swagger spec + ReDoc deployed to Github Pages (you can use a custom domain)
+ - OpenAPI spec is validated after each commit
+ - OpenAPI spec + ReDoc deployed to Github Pages (you can use a custom domain)
  - Live editing in your editor or `swagger-editor` :heart_eyes:
  ![live editing](./live-edit.gif)
 

cli.js

@@ -38,7 +38,7 @@ async function ask() {
       type: "input",
       name: "specFileName",
       message:
-        "Please specify the path to the OpenAPI/Swagger spec (local file):",
+        "Please specify the path to the OpenAPI spec (local file):",
       validate(fileName) {
         return validateSpecFileName(fileName);
       }
@@ -115,8 +115,13 @@ async function ask() {
 }
 
 function printSuccess(opts, root) {
+  let travisNote = '';
+  if (opts.travis) {
+    travisNote = `We generated ${chalk.blue('.travis')} for you. Follow steps from ${chalk.blue('README.md')} to finish Travis CI setup`
+  }
+
   console.log(`${chalk.green("Success!")} Created ${chalk.green(
-    path.dirname(root)
+    path.basename(root)
   )} at ${chalk.blue(root)}
 Inside that directory, you can run several commands:
   
@@ -131,15 +136,13 @@ Inside that directory, you can run several commands:
   ${chalk.blue(`npm test`)}
     Validates the spec.
   
-${opts.travis &&
-    `  ${chalk.blue(`npm run deploy`)}
-    Deploys the spec to GitHub Pages. You don't need to run it manually if you have Travis CI configured.
-`}
+  ${chalk.blue(`npm run gh-pages`)}
+    Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.
 
 We suggest that you begin by typing:
 
-  ${chalk.blue("cd")} ${path.dirname(root)}
-  ${chalk.blue("npm start")}`);
+  ${chalk.blue("cd")} ${path.basename(root)}
+  ${chalk.blue("npm start")}` + (travisNote ? '\n\n' + travisNote : ''));
 }
 
 async function run() {
@@ -176,7 +179,7 @@ Choose another directory or remove contents.
 
   const data = {
     ...opts,
-    packageName: slugify(opts.apiTitle),
+    packageName: slugify(opts.apiTitle).toLowerCase(),
     ghPagesBaseUrl: opts.repo ? getGhPagesBaseUrl(opts.repo) : undefined
   };
 
@@ -211,13 +214,13 @@ Choose another directory or remove contents.
 
   copyDirSync("web");
 
-  swaggerRepo.syncWithSwagger(fs.readFileSync(specFileName).toString());
+  swaggerRepo.syncWithSpec(fs.readFileSync(specFileName).toString());
 
   fs.writeFileSync(REDOCLY_RC, yaml.safeDump(opts, { skipInvalid: true }));
 
   console.log("Installing packages. This might take a couple of minutes.\n");
 
-  await installDeps(opts);
+  await installDeps('@^2.0.0-rc.2');
   console.log();
 
   try {

lib/install-deps.js

@@ -1,14 +1,14 @@
 const spawn = require("cross-spawn");
 
-exports.installDeps = opts => {
+exports.installDeps = (toolsVersion = '') => {
   const command = "npm";
   const args = [
     "install",
     "--save",
     "--loglevel",
     "error",
-    "swagger-repo"
-  ].concat(opts.travis ? ["deploy-to-gh-pages"] : []);
+    `swagger-repo${toolsVersion}`
+  ];
 
   return new Promise((resolve, reject) => {
     const child = spawn(command, args, { stdio: "inherit" });