Skip to content

Update README.md #134

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
ztbolick wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #134

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Addigy API SDK for Node.JS

This package takes the Addigy public API and wraps it into a consistent promise-based interface.
This package takes the Addigy's v1 public API and wraps it into a consistent promise-based interface.

:warning: Use this at your own risk. To error is human, to propogate error across all of prod via API is DevOps.

Expand Down Expand Up @@ -30,7 +30,7 @@ const addigy = new Addigy({
From there, you can call any of the `addigy` package functions (all of which are Promise-based) using `await` or with `=>` notation:

```js
const policies = await addigy.getPolicies()
const policies = await addigy.policies.getPolicies()
```

The response will be a JSON object or array, like so:
Expand Down