Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #31

Merged
merged 1 commit into from
Nov 20, 2023
Merged

Update README.md #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,22 +87,28 @@ await transaction.cancelInfo(); // Retrieve cancellation info

Find our full documentation online on [docs.buckaroo.io](https://docs.buckaroo.io/docs/node-sdk).

#### Need more examples?

More examples can be found in the [examples folder](https://github.com/buckaroo-it/BuckarooSDK_Node/tree/master/example)

***

### Regarding Usage Outside of Node.js
This library is written in JavaScript, a versatile programming language with broad applicability. While it's technically possible to integrate this library into a website or mobile application, it's strongly advised against doing so.

In the standard configuration, you make requests to the Buckaroo API using one of our provided libraries, typically from your server (such as a Node.js server). Your secret key is securely stored on this server, inaccessible to external entities.

However, if you incorporate this library directly into a website or app, your secret key will be exposed to users. This could enable users to take actions on your behalf using that key.

#### Need more examples?

More examples can be found in the [examples folder](https://github.com/buckaroo-it/BuckarooSDK_Node/tree/master/example)
***

### Contribute

We really appreciate it when developers contribute to improve the Buckaroo plugins.
If you want to contribute as well, then please follow our [Contribution Guidelines](CONTRIBUTING.md).

***

### Versioning

<p>
Expand All @@ -113,6 +119,8 @@ If you want to contribute as well, then please follow our [Contribution Guidelin
- **MINOR:** Changes that should not have a big impact
- **PATCHES:** Bug and hotfixes only

***

### Additional information

- **Support:** https://support.buckaroo.eu/contact
Expand Down