Updated documentation and removed bloat

BlackPhlox · May 7, 2020 · 34d98c5 · 34d98c5
1 parent 911f27c
commit 34d98c5
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 7 deletions.
diff --git a/.github/workflows/npmpub.yml b/.github/workflows/npmpub.yml
@@ -1,4 +1,4 @@
-name: publish wt-editor-cli on release
+name: release
 
 on:
   release:

diff --git a/README.md b/README.md
@@ -1,14 +1,20 @@
 # wt-editor-cli
+## Statuses
+[![GitHub version](https://badge.fury.io/gh/BlackPhlox%2Fwt-editor-cli.svg)](https://badge.fury.io/gh/BlackPhlox%2Fwt-editor-cli)
+![release](https://github.com/BlackPhlox/wt-editor-cli/workflows/release/badge.svg)
+[![npm version](https://badge.fury.io/js/wt-editor-cli.svg)](https://badge.fury.io/js/wt-editor-cli)
+
 ![wt-editor-cli-showcase](https://user-images.githubusercontent.com/25123512/68077919-ba2a4980-fdcc-11e9-879f-6e1fecb6bb20.gif)
 A command line editor for Windows Terminal settings
+
 # Prerequisites
   - Running Windows 7 or later
   - Have the latest version of Windows Terminal (Preview) installed
   - Have Node.js 12 installed or later
   - Have npm (Comes with Node.js)
 # Setup
-  - Clone this repo ```git clone https://github.com/BlackPhlox/wt-editor-cli.git```
-  - (Important) If you already have configured your `profiles.json`, I highly recommend you backup your file, just in case. The file can be found here: `%appdata%\..\Local\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\`
+  - Clone this repo ```git clone https://github.com/BlackPhlox/wt-editor-cli.git``` or<br> using ```npm install -g wt-editor-cli ```
+  - (Important) If you already have configured your `settings.json`, I highly recommend you backup your file, just in case. The file can be found here: `%appdata%\..\Local\Packages\Microsoft.WindowsTerminal_8wekyb3d8bbwe\LocalState\`
   - Go into the folder `cd wt-editor-cli`
   - Run `setup.bat`
   - Run `wte`

diff --git a/inquirer-file-tree-selection-prompt-custom/index.js b/inquirer-file-tree-selection-prompt-custom/index.js
@@ -3,6 +3,11 @@
  * `file-tree-selection` type prompt
  */
 
+/*
+  Customzied from "inquirer-file-tree-selection-prompt": "^1.0.2"
+  See package.json or npm install inquirer-file-tree-selection-prompt
+*/
+
 const fs = require('fs');
 const _ = require('lodash');
 const chalk = require('chalk');

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "wt-editor-cli",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Commandline application to change Windows Terminal settings in realtime",
   "main": "index.js",
   "scripts": {
@@ -17,8 +17,7 @@
     "fuzzy": "^0.1.3",
     "inquirer": "^7.0.0",
     "inquirer-autocomplete-prompt": "^1.0.1",
-    "inquirer-chalk-pipe": "^1.3.0",
-    "inquirer-file-tree-selection-prompt": "^1.0.2"
+    "inquirer-chalk-pipe": "^1.3.0"
   },
   "repository": {
     "type": "git",

diff --git a/util.js b/util.js
@@ -11,7 +11,7 @@ read = function(path){
         let rawdata = fs.readFileSync(path);
         return JSON.parse(rawdata);
     } catch(err){
-        console.error("No config found, remember to run generateConfig.bat");
+        console.error("Parse error: No settings.json or config.json found, if there is a config.json file, the path to settings.json might be incorrect, else run setup.bat again");
         throw err;
     }
 }