Merge pull request #10 from ev-the-dev/upkeep/readme

Upkeep/readme

README.md

@@ -4,25 +4,36 @@ Additionally it will include appropriate scripts and dependencies in the `packag
 
 Written in Go
 
+## Installation
+```sh
+$ npm i -g @ev-the-dev/tmplts
+```
+
 ## Current Functionality
+### Selectively Choose Files
+This will allow you to choose your own app name and choose which configurations you'd like to include/exclude.
+```sh
+$ tmplts
+```
+
 ### Auto-Generate All Files
 This will include configuration files automatically for: eslint, jest, swc, tsconfig.
 It will also default the app name to the name of the current working directory.
 ```sh
 $ tmplts -a
 ```
 
-### Selectively Choose Files
-This will allow you to choose your own app name and choose which configurations you'd like to include/exclude.
+### List Available Tool Commands and Options
 ```sh
-$ tmplts
+$ tmplts -h
 ```
 
 ## Roadmap
 * Add Prettier and its config file.
 * Add more CLI options, like --version/-v.
 * Implement checks for existing files in cwd. The tool should not overwrite files, but append to them if they already exist.
 * Simple GitHub deploy workflow adjustment to copy over README and LICENSE into the npm dir prior to publishing.
+* Provide alternative ways to install binaries other than via the npm registry -- i.e. curl, brew, apt, etc.
 * More robust configurations: able to selectively add rulesets to each config, instead of having to opt into the entire file as is.
 * Automated scripts: go ahead and include any necessary, or quality of life, scripts to get an app up-and-running with minimal effort.
 * Add functionality to include popular libraries:

npm/README.md

@@ -4,25 +4,36 @@ Additionally it will include appropriate scripts and dependencies in the `packag
 
 Written in Go
 
+## Installation
+```sh
+$ npm i -g @ev-the-dev/tmplts
+```
+
 ## Current Functionality
+### Selectively Choose Files
+This will allow you to choose your own app name and choose which configurations you'd like to include/exclude.
+```sh
+$ tmplts
+```
+
 ### Auto-Generate All Files
 This will include configuration files automatically for: eslint, jest, swc, tsconfig.
 It will also default the app name to the name of the current working directory.
 ```sh
 $ tmplts -a
 ```
 
-### Selectively Choose Files
-This will allow you to choose your own app name and choose which configurations you'd like to include/exclude.
+### List Available Tool Commands and Options
 ```sh
-$ tmplts
+$ tmplts -h
 ```
 
 ## Roadmap
 * Add Prettier and its config file.
 * Add more CLI options, like --version/-v.
 * Implement checks for existing files in cwd. The tool should not overwrite files, but append to them if they already exist.
 * Simple GitHub deploy workflow adjustment to copy over README and LICENSE into the npm dir prior to publishing.
+* Provide alternative ways to install binaries other than via the npm registry -- i.e. curl, brew, apt, etc.
 * More robust configurations: able to selectively add rulesets to each config, instead of having to opt into the entire file as is.
 * Automated scripts: go ahead and include any necessary, or quality of life, scripts to get an app up-and-running with minimal effort.
 * Add functionality to include popular libraries:

npm/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ev-the-dev/tmplts",
   "author": "ev-the-dev",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "TypeScript Project Configuration Bootstrapper",
   "license": "Apache-2.0",
   "bin": {