Add config description to readme

dmstern · Jul 27, 2018 · cfca915 · cfca915
1 parent d02b9b4
commit cfca915
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,19 @@ A nice npmjs.org-like web interface for jFrog Artifactory
 npm install
 ```
 
+Create a file `.jsfrog.config.json`in your home directory with the following properties:
+
+```json
+{
+  "artifactory": {
+    "baseURL": "http://<YOUR_ARTIFACTORY_BASE_URL>",
+    "apiKey": "<YOUR_ARTIFACTORY_API_KEY>",
+    "repoKey": "npm"
+  }
+}
+
+```
+
 ## Start App (Server and WebUI)
 
 ```bash