Skip to content

Commit a0eeec9

Browse files
MehrdadMehrdad
Mehrdad
authored and
Mehrdad
committed
docs: Update the README.md file
Formatting was updated with Markdown. Additional information on contribution and setup was added.
1 parent 1d2ee3c commit a0eeec9

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

README.md

+27-9
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,38 @@
1-
# Bitcoin-API
1+
# Bitcoin API
22

33
## Overview
44

5-
A sample Bitcoin API app that shows the current value of this cryptocurrency in a list of different currencies. This app uses "Bitcoin Average API" to fetch data and was completed as an assignment for Seneca College course in iOS Mobile Application Development.
5+
A sample Bitcoin API app that shows the current value of this cryptocurrency in a list of different currencies. This app uses [Bitcoin Average API](https://apiv2.bitcoinaverage.com/) to fetch data and was completed as an assignment for Seneca College course in iOS Mobile Application Development by using fundamental principles as follows:
66

7-
GCD and multi-threading
8-
UIPickerView
9-
GET Request, API & Web Services
10-
Parsing JSON
11-
Error Handling
7+
* GCD and multi-threading
8+
* UIPickerView
9+
* GET Request, API & Web Services
10+
* Parsing JSON
11+
* Error Handling
1212

13-
Language: Swift
13+
Language: Swift
1414
Assignment for: Seneca College - iOS Mobile Application Development course
15-
The API address: https://apiv2.bitcoinaverage.com/
15+
16+
17+
## Resources
18+
Bitcoin Average API: <https://apiv2.bitcoinaverage.com/>
19+
1620

1721
## Setup
22+
You need to replace you unique API Key for Bitcoin Average API in the following static property of the `BitcoinAPI` class. This projects needs no additional setup.
23+
24+
```swift
25+
static let apiKey = "ENTER API KEY HERE"
26+
```
27+
28+
## Contributing
29+
30+
Feel free to contribute to **Bitcoin API**. Fork and clone this repository, then make a pull request once you have pushed your changes.
31+
1832

1933
## Maintainers
2034
m-ahmadian
35+
36+
37+
## License
38+
**Bitcoin API** is available under the [MIT License](https://github.com/m-ahmadian/Bitcoin-API/blob/master/LICENSE).

0 commit comments

Comments
 (0)