Skip to content

Commit

Permalink
Merge pull request #99 from zackurben/feat/add-contributing
Browse files Browse the repository at this point in the history
Adding initial CONTRIBUTING.md file.
  • Loading branch information
zackurben committed Oct 13, 2020
2 parents 40e5178 + 7db5cb8 commit c47bc04
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributing

All contributions are welcome! The purpose of this library is to keep function parity with the Alpha Vantage API, while keeping a slim and intuitive programming interface. Before any pull requests are made, please run `npm run lint` to fix style issues and ensure that all test are passing `npm test`. New pull requests should contain, or fix, tests to ensure the code coverage is not reduced. If you need help, feel free to tag me in the pull request comments!

The build script, `npm run build`, can be used to rebuild the UMD module `dist/bundle.js` and it should be updated with each pull request.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

This is a simple wrapper around the [Alpha Vantage API](https://www.alphavantage.co/documentation/) hosted on [NPM](https://www.npmjs.com/package/alphavantage). I have no affiliation with AlphaVantage. This library can be used in the browser or in node since it is packaged as a UMD module.

All contributions are welcome! This is an open source project under the MIT license, see [LICENSE.md](LICENSE.md) for additional information.
All contributions are welcome, see our [CONTRIBUTING.md](CONTRIBUTING.md)! This is an open source project under the MIT license, see [LICENSE.md](LICENSE.md) for additional information.

`All available functions with this SDK have the same parameters as listed in the the Alpha Vantage Docs, without the "function" or "apikey". Do not include the "function" or "apikey" parameters when using this library. All functions return promises with the response data.`

Expand Down Expand Up @@ -50,23 +50,23 @@ const alpha = require('alphavantage')({ key: 'qweqweqwe' });

```javascript
// Simple examples
alpha.data.intraday(`msft`).then(data => {
alpha.data.intraday(`msft`).then((data) => {
console.log(data);
});

alpha.forex.rate('btc', 'usd').then(data => {
alpha.forex.rate('btc', 'usd').then((data) => {
console.log(data);
});

alpha.crypto.daily('btc', 'usd').then(data => {
alpha.crypto.daily('btc', 'usd').then((data) => {
console.log(data);
});

alpha.technical.sma(`msft`, `daily`, 60, `close`).then(data => {
alpha.technical.sma(`msft`, `daily`, 60, `close`).then((data) => {
console.log(data);
});

alpha.performance.sector().then(data => {
alpha.performance.sector().then((data) => {
console.log(data);
});
```
Expand Down Expand Up @@ -192,12 +192,6 @@ See [Alpha Vantage](https://www.alphavantage.co/documentation/#sector-informatio
alpha.performance.sector();
```

## Contributing

All contributions are welcome! The purpose of this library is to keep function parity with the Alpha Vantage API, while keeping a slim and intuitive programming interface. Before any pull requests are made, please run `npm run lint` to fix style issues and ensure that all test are passing `npm test`. The codebase should always remain at 100% test coverage.

The build script, `npm run build`, can be used to rebuild the UMD module `dist/bundle.js` and it should be updated with each pull request.

## Contact

- Author: Zack Urben
Expand Down

0 comments on commit c47bc04

Please sign in to comment.