Skip to content

Commit

Permalink
📝 Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredsmithse committed Oct 13, 2019
1 parent 83f27ed commit 2d6b6ad
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
@@ -1,6 +1,11 @@
# monzo.cr

TODO: Write a description here
[![Build Status](https://travis-ci.org/jaredsmithse/monzo.cr.svg?branch=master)](https://travis-ci.org/jaredsmithse/monzo.cr)
[![GitHub license](https://img.shields.io/github/license/c910335/mass-spec.svg)](https://github.com/c910335/mass-spec/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/jaredsmithse/monzo.svg)](https://github.com/jaredsmithse/monzo.cr/releases)

The Monzo API is designed to be a predictable and intuitive interface for interacting with users’ accounts.
This is an API wrapper client for Monzo. It is still under construction and all help is welcome!

## Installation

Expand All @@ -9,31 +14,45 @@ TODO: Write a description here
```yaml
dependencies:
monzo.cr:
github: your-github-user/monzo.cr
github: jaredsmithse/monzo.cr
```

2. Run `shards install`

## Usage

#### Configuration
Instructions for obtaining your own API token can be found on the Monzo documentation website [here](https://docs.monzo.com/#authentication).
```crystal
require "monzo.cr"
require "monzo"
Monzo::Client.configure do |settings|
settings.access_token = monzo_access_token
settings.base_url = "https://api.monzo.com"
end
client = Monzo::Client
```

TODO: Write usage instructions here
#### Getting All Accounts Belonging To You
```crystal
client = Monzo::Client
accounts = client.accounts.list.each do |account|
puts account.id
end
```

## Development

TODO: Write development instructions here
For development, you will need a personal access token from Monzo. You can find instructions on how to acquire one for your account [here](https://docs.monzo.com/#authentication).

## Contributing

1. Fork it (<https://github.com/your-github-user/monzo.cr/fork>)
1. Fork it (<https://github.com/jaredsmithse/monzo.cr/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [your-name-here](https://github.com/your-github-user) - creator and maintainer
- [@jaredsmithse](https://github.com/jaredsmithse) Jared Smith - creator, maintainer

0 comments on commit 2d6b6ad

Please sign in to comment.