diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dd6c20e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +### How to contribute to the bunq Python SDK 😎 + +#### Want to add a new amazing feature to our SDK? πŸš€ +- First let’s discuss the feature that you would like to add. [Open a new issue](https://github.com/bunq/bunq-Python/issues/new), describe the feature and explain why you think it should be added. +- Once we agree on the new feature, open a new GitHub pull request and include all the relevant information to get your code approved! + +#### Did you find a bug? πŸ› +- Before opening a new issue check if the bug hasn't already been reported by searching on GitHub under [issues](https://github.com/bunq/bunq-Python/issues). +- If it hasn't already been reported you can [open a new issue](https://github.com/bunq/bunq-Python/issues/new). Make sure you include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behaviour that is not occurring. +- If you wrote a patch that fixes a bug, open a new GitHub pull request and make sure to clearly describe the problem and your awesome solution. + +#### Do you have questions about the source code? +- You are welcome to ask whatever you want about the bunq Python SDK on [Together](https://together.bunq.com) 🎀 + +#### Are you looking for a challenging new adventure? +- We're always looking for the best developers to come and join us at the Bank of the Free! 🌈 [Check out our vacancies](https://www.bunq.com/en/jobs)! + +Thanks, and have fun! πŸ’ͺ diff --git a/README.md b/README.md index 08e67b3..02fb5bb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,26 @@ -# bunq Java SDK +# bunq Python SDK Version 0.9.0 **BETA** +## Introduction +Hi developers! + +Welcome to the bunq Python SDK! πŸ‘¨β€πŸ’» + +We're very happy to introduce yet another unique product: complete banking SDKs! +Now you can build even bigger and better apps and integrate them with your bank of the free! 🌈 + +Before you dive into this brand new SDK, please consider: +- Checking out our new developer’s page [bunq.com/developers](https://bunq.com/developers) πŸ™Œ +- Grabbing your production API key from the bunq app or asking our support for a Sandbox API key πŸ— +- Visiting [together.bunq.com](https://together.bunq.com) where you can share your creations, +questions and experience 🎀 + +Give us your feedback, create pull requests, build your very own bunq apps and most importantly: +have fun! πŸ’ͺ + +This SDK is in **beta**. We cannot guarantee constant availability or stability. +Thanks to your feedback we will make improvements on it. + ## Installation In the root of your project, being in the correct virtual environment, run: ```shell