diff --git a/README.md b/README.md index 20f4471..ea81e81 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ # ngrok-to-dotenv -ngrok-to-dotenv is a node cli tool that you can use with projects that need ngrok. You clone it into your project's folder, and setup a package.json script to call "cd ngrok-to-dotenv && node ngrok" \ No newline at end of file +This is a ngrok start-up wrapper that uses a dotenv file to get the authtoken and save the https address; it's a node cli tool that you can use with projects that need ngrok. You clone it into your project's folder, and setup a package.json script to call "cd ngrok-to-dotenv && node ngrok". Be sure to add the folder to your .gitignore and and install the one package which is ngrok, with 'npm -i' or 'yarn'.