Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bastienbeurier authored Mar 24, 2023
1 parent 70fbd88 commit 8b2e8a2
Showing 1 changed file with 18 additions and 23 deletions.
41 changes: 18 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<h1 align="center">Get OAuth tokens for APIs. Fast & secure.</h1>

<div align="center">
Pre-built OAuth flows & secure token management for 50+ APIs. 100% open source.
Pre-built OAuth flows & secure token management for 60+ APIs. 100% open source.
</div>

<p align="center">
Expand Down Expand Up @@ -39,27 +39,27 @@ Nango is a service that contains everything you need to work with APIs that use

It contains:

- a full OAuth dance for 50+ APIs
- a full OAuth dance for 60+ APIs
- a frontend SDK to trigger new OAuth flows
- a backend SDK & REST API to retrieve fresh access tokens for your API calls

Nango is easy to try in 5 minutes and can be deployed in 15:
Nango is easy to try in 5 minutes:

- 1-liner to start a new OAuth flow in your frontend:

```ts
let result = await nango.auth('github', '<user-id>');
```

- 1-liner to retrieve a token (with our SDK or REST API):
- 1-liner to retrieve a fresh token (with our SDK or REST API):

```ts
let token = await nango.getToken('github', '<user-id>');
```

## 👾 Out of the box support for 50+ APIs
## 👾 Out of the box support for 60+ APIs

50+ APIs are preconfigured to work out-of-the-box. Including:
60+ APIs are preconfigured to work out-of-the-box. Including:

- **CRM**: Front, Hubspot, Salesforce, etc.
- **Accounting**: Xero, Sellsy, Zoho Books, etc.
Expand All @@ -72,28 +72,23 @@ let token = await nango.getToken('github', '<user-id>');

If your favorite API is missing [open a GitHub issue](https://github.com/NangoHQ/nango/issues/new) or [contribute it right away](https://docs.nango.dev/contribute-api): The API configurations are just simple [entries in a YAML file](https://github.com/NangoHQ/nango/blob/master/packages/auth/providers.yaml).

## 🛡️ Small, self-contained & ready for production

Nango is purposely small, focused on its one task and easy to deploy in production:

- Runs as a single docker container
- Updates easily (`docker pull`)
- Secured with an API key
- Managed with a CLI
- [Cloud hosting available](https://www.nango.dev/pricing)

Nango's community continuously maintains & expands API templates.

## 🚀 Demo & Quickstart

### 1 minute demo

[![Watch demo on YouTube](https://docs.nango.dev/img/nango-demo-video-yt-thumbnail.png)](https://youtu.be/S0VJx2KPCQg)

### Implement OAuth for any API in 15 minutes
### Test Nango in 5 minutes

Run
```
git clone https://github.com/NangoHQ/nango.git && cd nango
```
```
docker compose up # Keep the tab open
```

Ready to try Nango in your own app?
Follow our [Quickstart](https://docs.nango.dev/quickstart) to implement OAuth for your favorite API in your application in 15 minutes.
Go to http://localhost:3003 to configure your 1st OAuth flow!

## 🔍 Where to learn more

Expand All @@ -107,8 +102,8 @@ Follow our [Quickstart](https://docs.nango.dev/quickstart) to implement OAuth fo

Thank you for continuously making Nango better ❤️

<a href="https://github.com/NangoHQ/nango/graphs/contributors">
<img src="https://contrib.rocks/image?repo=NangoHQ/nango" />
<a href="https://github.com/nangohq/nango/graphs/contributors">
<img src="https://contrib.rocks/image?repo=nangohq/nango" />
</a>

## 🐻 History
Expand Down

0 comments on commit 8b2e8a2

Please sign in to comment.