Skip to content

Commit

Permalink
update read me (#384)
Browse files Browse the repository at this point in the history
* update read me

close #381

* add config

* add stripe version for 2.x

* reword
  • Loading branch information
snewcomer authored and begedin committed Jun 11, 2018
1 parent 565ba3c commit 8ada585
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The old `1.x.x` line of releases has been kept and is being published separately

The actively developed line of releases is `2.x.x` and is contained within the `master` branch. New features are being added to this line of releases, so to develop this library further, create pull requests against the master branch.

2.x.x Works with Stripe API version 2018-05-21

# Documentation

- [Latest HexDocs](https://hexdocs.pm/stripity_stripe/)
Expand All @@ -40,6 +42,15 @@ _Not necessary if using elixir >= 1.4_
defp application do
[applications: [:stripity_stripe]]
end

## Configuration

To make API calls, it is necessary to configure your Stripe secret key.

```ex
use Mix.Config

config :stripity_stripe, api_key: "YOUR SECRET KEY"
```

# Documentation for 1.x.x
Expand Down

0 comments on commit 8ada585

Please sign in to comment.