Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# GitHub Analytics with Keen IO

Stream event data from your GitHub repos to a Keen project via GitHub's event stream webhooks.

[Read more about this project here](https://blog.keen.io/tracking-github-data-with-keen-io-f130bcdec545).

Stream event data from your GitHub repos to a Keen project via GitHub's event stream webhooks.

### Installation

Expand All @@ -24,13 +21,9 @@ npm install

### Project ID & API Key

[Login to Keen IO to create a project](https://keen.io/login?s=gh_github-analytics) and grab the **Project ID** and **Write Key** from your project's **Access** page.

![image of Access page](access_page.png)

**If you are new to Keen IO** and have not sent your first event yet, you can find your **Project ID** and **Write Key** in the at the bottom of the cURL section of the onboarding docs:
[Visit Keen.io to sign up or request a demo](https://keen.io/). After obtaining an account grab the **Project ID** and **Write Key** from your project's **Access** page.

![image of cURL section](curl_section.png)
**If you are new to Keen IO** and have not sent your first event yet, you can find your **Project ID** and **Write Key** in the access tab of the portal.

Copy these into the `KEEN_PROJECT_ID` and `KEEN_WRITE_KEY` fields of the `.env` file created previously, or set these environmental variables manually:

Expand Down