Skip to content

Commit

Permalink
Merge pull request #8 from jessica-jordan/update-readme
Browse files Browse the repository at this point in the history
Update Readme
  • Loading branch information
jayjayjpg authored Nov 20, 2018
2 parents c298224 + 784b752 commit 9ea2eed
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# whats-new-in-emberland

This README outlines the details of collaborating on this Ember application.
A short introduction of this app could easily go here.
This is an overview app of Ember-related Github activity used by the investigative folks over at [The Ember Times](https://twitter.com/embertimes) to find new, relevant topics for the newsletter.

## Prerequisites

Expand All @@ -16,7 +15,14 @@ You will need the following things properly installed on your computer.

* `git clone <repository-url>` this repository
* `cd whats-new-in-emberland`
* `npm install`
* `yarn`
* if you do not have one yet, please create a valid Github API Token [here](https://github.com/settings/tokens).
Each token you're generating already comes with the suitable set of permissions to read all the public repository info that is required to run this app. There's no need for you to tick any of the additional permissions scope options in the token generation wizard.
* Set your token in your `~/.bashrc` file as follows:
```bash
export GITHUB_API_KEY="my-key-id"
```
* run `source ~/.bashrc` to give your current terminal window access to the updated env variables

## Running / Development

Expand Down

0 comments on commit 9ea2eed

Please sign in to comment.