Merge pull request #4 from missmatsuko/develop

Develop

README.md

@@ -1,3 +1,26 @@
 # asl-tab-api
 
 Get a YouTube channel's video data to use in the [ASL Tab browser extension](https:/missmatsuko/asl-tab).
+
+## Instructions
+
+```
+# 1. Install packages from `package-lock.json`.
+npm ci
+
+# 2. Copy `.env.example` file to `.env` file.
+cp .env.example .env
+
+# 3. Manually update `.env` contents
+# Key names are pretty self-explanatory
+# Currently this project is only built to pull data from a single YouTube playlist
+
+# 4. Run local build and upload
+# Note: The more items there are in the playlist, the longer this will take.
+# Note: Currently, this will always upload a file named `data.json`.
+# This can be edited in `index.js`.
+npm start
+
+# 5. Create dist.zip for manual upload to an AWS Lambda function.
+npm run package
+```

package.json

@@ -1,6 +1,6 @@
 {
  "name": "asl-tab-api",
- "version": "1.0.0",
+ "version": "1.0.1",
  "description": "Get a YouTube channel's video data to use in the ASL Tab browser extension.",
  "main": "index.js",
  "scripts": {
@@ -19,12 +19,12 @@
  },
  "homepage": "https:/missmatsuko/asl-tab-api#readme",
  "dependencies": {
- "esm": "^3.0.84",
- "iso8601-duration": "^1.1.6",
- "node-fetch": "^2.2.1"
+ "esm": "^3.2",
+ "iso8601-duration": "^1.2",
+ "node-fetch": "^2.6"
  },
  "devDependencies": {
- "aws-sdk": "^2.355.0",
- "dotenv": "^6.1.0"
+ "aws-sdk": "^2.610",
+ "dotenv": "^8.2"
  }
 }