Skip to content

Commit

Permalink
Adjust language in readme (NangoHQ#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
markmichon authored Jun 9, 2020
1 parent 71a4bcd commit d24d106
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The OAuth Integration Proxy
-->
</div>

Pizzly is an OAuth Integration Proxy that acts as an abstraction layer to simplify integrating with OAuth API. It let you connect out-of-the-box to 50+ OAuth APIs and automatically manage retrieving, storing and refreshing OAuth tokens. It also supports adding new OAuth API by using a simple file definition.
Pizzly is an OAuth Integration Proxy that acts as an abstraction layer to simplify integrating with OAuth API. It lets you connect 50+ OAuth APIs out-of-the-box and automatically manages retrieving, storing, and refreshing OAuth tokens. It also supports adding new OAuth APIs by using a simple file definition.

Pizzly is made available as an open-source project by [Bearer.sh](https://bearer.sh/?ref=pizzly).

Expand All @@ -36,7 +36,7 @@ Pizzly is made available as an open-source project by [Bearer.sh](https://bearer

## Why Pizzly?

Pizzly is an original project, originally started at Bearer.sh, to simplify developer's journey and ease how to build API integrations. OAuth is a great framework but the difficulty and wide range of implementation makes it painful to use and tend to slow down the ability to integrate with new APIs.
Pizzly originally started at Bearer.sh as a way to simplify the developer's journey and ease the building of API integrations. OAuth is a great framework, but the difficulty and wide range of implementation makes it painful to use and tends to slow down the ability to integrate with new APIs.

_But seriously, why Pizzly? We're fan of bears and fell in love with this [sweet hybrid](https://en.wikipedia.org/wiki/Grizzly–polar_bear_hybrid) one 🐻_

Expand All @@ -46,28 +46,28 @@ You can use Pizzly as a **complete API proxy**, it means that each API request w

![Diagram of Pizzly used in the proxy service mode](views/assets/img/docs/pizzly-diagram-api-proxy-mode.jpg?raw=true)

Pizzly is also available as a standalone **OAuth manager**, helping you to retrieve the initial token, but you'll have to refresh it when needed. _(see Getting Started below)_.
Pizzly is also available as a standalone **OAuth manager**, helping you retrieve the initial token, but you'll have to refresh it when needed. _(see Getting Started below)_.

![Diagram of Pizzly used in the token manager mode](views/assets/img/docs/pizzly-diagram-token-manager-mode.jpg?raw=true)

### Understanding the **AuthId** concept

It's important to understand the AuthId concept behind Pizzly. The AuthId is an identifier masking OAuth tokens. Since most OAuth tokens need to be refreshed, and therefore will change, but still represent a common identity _(especially a user identity when performing 3-legged OAuth),_ the AuthId serve as an abstraction layer. To say it differently, an AuthId represents an identity that will have many tokens overtime.
It's important to understand the AuthId concept behind Pizzly. The AuthId is an identifier masking OAuth tokens. Since most OAuth tokens need to be refreshed, and therefore will change, the AuthId serves as an abstraction layer to the identity itself. To say it differently, an AuthId represents an identity that will have many tokens overtime.

## Key Features

- Manage retrieving, storing and refreshing OAuth tokens _(aka the OAuth dance)_
- No scopes limitation
- Manage retrieving, storing, and refreshing OAuth tokens _(aka the OAuth dance)_
- No scope limitations
- Retrieve and store complete OAuth payload
- Support of OAuth 1, Oauth 1a and OAuth 2.0
- Support of OAuth 1, OAuth 1a and OAuth 2.0
- JavaScript library to connect from your web-app (three-legged OAuth flow)
- Provide configurations for over 50+ OAuth APIs (see list below)
- Provides configurations for over 50+ OAuth APIs (see list below)
- Support adding new OAuth APIs using a file definition
- 1-click deploy to Heroku or major cloud hosting solution
- 1-click deploy to Heroku or major cloud hosting solutions

## Installation

At the heart of Pizzly is a Node.js application that uses PostgreSQL as a database. It straightforward to install on Heroku using the **Deploy to Heroku** button, but you can install it anywhere.
At the heart of Pizzly is a Node.js application that uses PostgreSQL as a database. It is straightforward to install on Heroku using the **Deploy to Heroku** button, but you can install it anywhere.

### Manual Install

Expand Down Expand Up @@ -146,7 +146,7 @@ Here's an example with the GitHub configuration file ([`/integration/github.json
}
```

To add a new API, just create a new configuration file. Here's a step-by-step guide on [how to create a new configuration file](https://github.com/Bearer/Pizzly/wiki/TODO).
To add a new API, create a new configuration file. Here's a step-by-step guide on [how to create a new configuration file](https://github.com/Bearer/Pizzly/wiki/TODO).

## License

Expand Down

0 comments on commit d24d106

Please sign in to comment.