Updates to UI and API READMEs

cfree · Aug 22, 2018 · b6c1abc · b6c1abc
1 parent e331d38
commit b6c1abc
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 2,415 deletions.
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1,15 @@
+# JavaScript Framework Roulette API
+
+## Available Endpoints
+
+`/random` - Returns a randomly-chosen framework from the `frameworks.json` list
+
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the API in the development mode.<br>
+Open [http://localhost:5001](http://localhost:5001) to view it in the browser.
diff --git a/api/package.json b/api/package.json
@@ -6,5 +6,8 @@
   "private": true,
   "dependencies": {
     "express": "^4.16.3"
+  },
+  "scripts": {
+    "start": "node ."
   }
 }