diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ccf253c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.1.0] - 2020-01-28 +### Added +* [Code of conduct](CODE-OF-CONNDUCT.md) By [@Rincorpes](https://github.com/Rincorpes) +* [Conntributing](CONTRIBUTING.md) By [@Rincorpes](https://github.com/Rincorpes) +* [Change Log](CHANGELOG.md) By [@Rincorpes](https://github.com/Rincorpes) +* Changelog badge. By [@Rincorpes](https://github.com/Rincorpes) +### Changed +* [README.md] By [@wickathou](https://github.com/wickathou) + diff --git a/README.md b/README.md index 5e6d173..3890dcd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url] +[![Changelog][changelog-shield]][changelog-url] [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]
@@ -67,13 +67,12 @@ All you will need is your HMAC Auth key and secret wich you can get from [here]( For more information check the [Localbitcoins API Documentation](https://localbitcoins.com/api-docs/) -**Require the library:** - + // Require the `unizend-localbtc`and the `doetnv` config const lbtc = require('./unizend-localbtc') + require('dotenv').config() -**Call the `init()` method:** - - lbtc.init(YOUR_HMAC_AUTH_KEY, YOUR_HMAC_AUTH_SECRET) + // Call the `init()` method + lbtc.init(process.env.AUTH_KEY, process.env.AUTH_SECRET) ## Roadmap