Skip to content

Tweak readme #5

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

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

Tweak readme #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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Twitch Authentication Node Sample
Here you will find a simple Express web app illustrating how to authenticate Twitch API calls using the OAuth authorization code flow. This sample uses [Express](http://expressjs.com/), [Passport](http://passportjs.org/), and [Handlebars](http://handlebarsjs.com/).
Here you will find a simple Express web app illustrating how to authenticate a User (also known as logging a user into your application/website) against the Twitch API using the [OAuth authorization code flow](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth#oauth-authorization-code-flow).

This sample uses [Express](http://expressjs.com/), [Passport](http://passportjs.org/), and [Handlebars](http://handlebarsjs.com/).

This authentication method is good for applications where you will be performing actions on behalf of the Authentication user. If you are building a Website to show Streamer live status for example, then this example is not the best solution, as you shoud be using a [Server to Server/Client Credentials token](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth#oauth-client-credentials-flow) and not logging a user in at all

## Installation
After you have cloned this repository, use [npm](https://www.npmjs.com/) to install dependencies.
Expand Down