README

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 15.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test

README.md

@@ -1,12 +1,10 @@
 # PLATFORM to Orbit Workspace
 
-<!-- Update repo name -->
-![Build Status](https://github.com/orbit-love/repo-name/workflows/CI/badge.svg)
-<!-- Generator at https://badge.fury.io/ -->
-[![Gem Version](https://badge.fury.io/rb/dev_orbit.svg)](https://badge.fury.io/rb/dev_orbit)
+![Build Status](https://github.com/orbit-love/community-js-youtube-orbit/workflows/CI/badge.svg)
+[![npm version](https://badge.fury.io/js/%40orbit-love%2Fyoutube.svg)](https://badge.fury.io/js/%40orbit-love%2Fyoutube)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](.github/CODE_OF_CONDUCT.md)
 
-One-line description about what this is and what language it is in.
+This is a JavaScript package that can be used to integrate YouTube comments from videos uploaded to a specified channel into your organization's Orbit workspace.
 
 |<p align="left">:sparkles:</p> This is a *community project*. The Orbit team does its best to maintain it and keep it up to date with any recent API changes.<br/><br/>We welcome community contributions to make sure that it stays current. <p align="right">:sparkles:</p>|
 |-----------------------------------------|
@@ -15,9 +13,12 @@ One-line description about what this is and what language it is in.
 
 ## First Time Setup
 
-<!-- If this section is short, delete docs/setup.md and write the guide under this heading -->
+To set up this integration you will need some details from YouTube.
 
-To set up this integration you will need some details from PLATFORM. To get these details please follow the [First Time Setup guide](docs/setup.md).
+1. Create a project in the [Google Developers Console](https://console.developers.google.com/)
+2. After creating your project, make sure the YouTube Data API is one of the services that your application is registered to use.
+3. Go to the Credentials area of your application and create an API Key. Take note of the API Key as it will only be shown once.
+4. Get your Channel's ID by [following these steps](https://support.google.com/youtube/answer/3250431).
 
 ## Application Credentials
 
@@ -25,7 +26,8 @@ The application requires the following environment variables:
 
 | Variable | Description | More Info
 |---|---|--|
-| `NAME` | Brief description | Where to get it 
+| `YOUTUBE_API_KEY` | Allows you to use the YouTube Data API | Follow the guide above
+| `YOUTUBE_CHANNEL_ID` | The ID of the channel you want to scan for comments | Follow the guide above
 | `ORBIT_API_KEY` | API key for Orbit | Found in `Account Settings` in your Orbit workspace
 | `ORBIT_WORKSPACE_ID` | ID for your Orbit workspace | Last part of the Orbit workspace URL, i.e. `https://app.orbit.love/my-workspace`, the ID is `my-workspace`
 
@@ -34,32 +36,57 @@ The application requires the following environment variables:
 Install the package with the following command
 
 ```
-$ installation command
+$ npm install @orbit-love/youtube
 ```
 
 Use the package with the following snippet.
 
-```
-#
+```js
+const OrbitYouTube = require('@orbit-love/youtube')
+const orbitYouTube = new OrbitYouTube()
+
+// Allows you to go back a number of hours and only get comments in that timeframe
+const videos = await orbitYouTube.getComments({ channelId: YOUTUBE_CHANNEL_ID, hours: 24 })
+const comments = await orbitYouTube.prepareComments(videos)
+const response = await orbitYouTube.addActivities(comments)
+console.log(response) // "Added n activities to the workspace-id Orbit workspace"
 ```
 
-<!-- Make sure all variants and standalone methods are explained. -->
+The standard initialization of the library requires the following signature:
+
+```js
+const OrbitYouTube = require('@orbit-love/youtube')
+const orbitYouTube = new OrbitYouTube('orbitWorkspaceId', 'orbitApiKey', 'ytApiKey', 'ytChannelId')
+```
+
+If you have the following environment variables set: `ORBIT_WORKSPACE_ID`, `ORBIT_API_KEY`, `YOUTUBE_API_KEY`, and `YOUTUBE_CHANNEL_ID` then you can initialize the client as follows:
+
+```js
+const OrbitYouTube = require('@orbit-love/youtube')
+const orbitYouTube = new OrbitYouTube()
+```
 
 ## CLI Usage
 
-To use this package you DO/DO NOT need to install it.
+To use this package you do not need to install it, but will need Node.js installed on your machine.
 
 ```
-#
+npx @orbit-love/youtube --comments --channel=id
 ```
 
-<!-- Explain any flags/config options -->
+By default this will get the last 24 hours worth of activity, but this can be explicitly overridden:
+
+```
+npx @orbit-love/youtube --comments --channel=id --hours=24
+```
+
+To use the CLI you must have the following environment variables set: `ORBIT_WORKSPACE_ID`, `ORBIT_API_KEY`, `YOUTUBE_API_KEY`, and `YOUTUBE_CHANNEL_ID`.
 
 ## GitHub Actions Automation Setup
 
 ⚡ You can set up this integration in a matter of minutes using our GitHub Actions template. It will run regularly to add new activities to your Orbit workspace. All you need is a GitHub account.
 
-[See our guide for setting up this automation](#)
+[See our guide for setting up this automation](https://github.com/orbit-love/github-actions-templates/blob/main/YouTube/README.md)
 
 ## Contributing
 

docs/setup.md

@@ -1,11 +0,0 @@
-<small><a href="../README.md">Back to README</a></small>
-
-# First Time Setup
-
-<!-- This is a summary section. Explain what we need to do at a high-level. For example... -->
-
-During the setup, we will need to create a new application on Stack Apps which will allow this integration to interact with the platform. The application will contain a Key which we should take note of for later.
-
-1. Head to [Stack Apps](https://stackapps.com) and login in to your account.
-2. [Register a new Stack Apps application](https://stackapps.com/apps/oauth/register). The oauth domain can be anything, as can the application website.
-3. In your application settings, take note of your `Key` value.