Merge pull request #36 from bitvavo/FAVO-8366_Update-SDK-release-procedure_Iain

feat: add the contributing guide to the repo.

Author: IainTheTechWriter

CONTRIBUTING.md

@@ -1,23 +1,48 @@
 Contributing
 ============
 
+The release process for Bitvavo SDK for Node.js is semi-automatic. You manually start the GitHub Action that creates
+the SDK package and uploads it to [npmjs](https://www.npmjs.com/package/bitvavo).
+
 ## Prerequisites
-To release the SDK from your local development device you need:
-- Node installed on your development device
+
+To release the SDK you need to:
+
+- Complete the instructions in the [README Prerequisites](./README.md#prerequisites)
 - Clone https://github.com/bitvavo/node-bitvavo-api to your development device
-- The [Bitvavo password for NPM] from the Exchange Backbone team vault in 1Password
 
-## Test and Publish the SDK
-After you have made your changes to the SDK, to publish Bitvavo SDK for Node.js:
-1. **Test the package**
+## Release a new version of the SDK
+
+To update the SDK and publish your changes to the Bitvavo developer community:
+
+1. **Make your updates to the SDK**
+
+   Create a branch and implement your changes to the SDK.
+
+2. **Test the package**
    1. Run the smoke tests in `<repo-root>/example/testApi.js`
-2. **Release the SDK**
-   1. Run the [Release workflow]. Use [Semver] to choose the version number.
-   2. Fill out the notes in the [drafted release](https://github.com/bitvavo/node-bitvavo-api/releases).
-   3. Publish the release.
+   1. When your code passes the smoke tests, make a pull request
+      to the `master` branch.
+
+1. **Publish the SDK**
+
+   1. When your [pull request](https://github.com/bitvavo/node-bitvavo-api/pulls) is approved, merge your changes to
+      the `master` branch.
+   1. Note the release number of the
+      [latest version of the SDK published to npmjs](https://www.npmjs.com/package/bitvavo?activeTab=versions)
+      and using [semver](https://semver.org/) as your guide, decide on a version number for this release.
+   1. In Actions, [run the release action](https://github.com/bitvavo/node-bitvavo-api/actions/workflows/release.yml)
+      using your new release number.
+
+   1. Open the draft release created when you ran the release action.
+   1. Add a brief description about the release.
+
+      This description is visible to the world in https://github.com/bitvavo/node-bitvavo-api/releases.
+   1. Click **Publish**.
+
+      This starts the Publish action. You see the
+      [new version available on npmjs](https://www.npmjs.com/package/bitvavo).
+
+Now send the release message in Slack, yay.
 
-The new version is published to https://www.npmjs.com/package/bitvavo.
 
-[Bitvavo password for NPM]: https://start.1password.com/open/i?a=YUSMSDGGJBG5JDUAGUSBP4GYWM&v=asrum7nvbb2agfh3ob532ekbfy&i=f3i334rmzgxejycgufdwiiua3u&h=bitvavo.1password.com
-[Release workflow]: https://github.com/bitvavo/node-bitvavo-api/actions/workflows/release.yml
-[Semver]: https://semver.org/

README.md

@@ -5,6 +5,8 @@ You use Bitvavo SDK for Node.js to buy, sell, and store over 200 digital assets
 
 To trade and execute your advanced trading strategies, Bitvavo SDK for Node.js is a wrapper that enables you to easily call every endpoint in [Bitvavo API](https://docs.bitvavo.com/). Every function available on the API can be called through a REST request or over WebSocket.
 
+* [Prerequisites](#prerequisites)
+* [Install](#installation)
 * Getting started       [REST](#getting-started) [WebSocket](#getting-started-1)
 * General
   * Time                [REST](#get-time) [WebSocket](#get-time-1)
@@ -42,7 +44,27 @@ To trade and execute your advanced trading strategies, Bitvavo SDK for Node.js i
   * [Book Subscription With Local Copy](#book-subscription-with-local-copy)
   * [Unsubscribe](#unsubscribe)
 
+## Prerequisites
+
+To start programming with Bitvavo SDK for Node.js you need:
+
+- [Node.js](https://nodejs.org/en) installed on your development device
+- A Node app. Use your favorite IDE, or run from the command line
+- An [API key and secret](https://support.bitvavo.com/hc/en-us/articles/4405059841809) associated with your Bitvavo account
+
+  You control the actions your app can do using the rights you assign to the API key.
+  Possible rights are:
+  + **View**: retrieve information about your balance, account, deposit and withdrawals
+  + **Trade**: place, update, view and cancel orders
+  + **Withdraw**: withdraw funds
+
+    Best practice is to not grant this privilege, withdrawals using the API do not require 2FA and e-mail confirmation.
+
+
 ## Installation
+
+To install Bitvavo SDK for Node.js, run the following command in your Node app: 
+
 ```
 npm i bitvavo
 ```