From 65747089b17cc86402bae217a34e08fe157be173 Mon Sep 17 00:00:00 2001 From: Jon Allred Date: Fri, 9 Jun 2017 19:52:19 -0600 Subject: [PATCH] Create README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 118af69..7186f1c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Manage API calls on github to pull Adobe informations # Start -After installing dependencies with `npm install`, you can lunch the server with: +After installing dependencies with `npm install`, you can launch the server with: ``` node server.js @@ -13,7 +13,7 @@ node server.js # Use -Here is the routes you can call: +Here are the routes you can call: - `/` : every Adobe organisations, repositories, languages used on github. - `/update` : update all json, pulling them from adobe.github.com repo. @@ -22,7 +22,7 @@ Here is the routes you can call: ## Start server -If you want to lunch the process in background, simply use: +If you want to launch the process in background, simply use: ``` nohup node server.js & ``` @@ -30,9 +30,9 @@ nohup node server.js & ## GitHub account -In order for the app to make Github API calls without reaching the limit, you need to authentificate. +In order for the app to make Github API calls without reaching the limit, you need to authenticate. -The ID and pass are pulled from the local environement variables. Add those lines in your `~/.bashrc`: +The ID and pass are pulled from the local environment variables. Add those lines in your `~/.bashrc`: ``` export GHUSER=[userName] @@ -47,7 +47,7 @@ It is better to use PM2 to launch your instance in production. More info [here]( pm2 start server.js ``` -Once you push your server in production, you need to update your environnement variable NODE_ENV. It will mainly activating your NewRelic manager. +Once you push your server in production, you need to update your environment variable NODE_ENV. It will mainly activate your NewRelic manager. ``` export NODE_ENV=production @@ -68,4 +68,4 @@ sudo iptables-save ``` export PORT=80 -``` \ No newline at end of file +```