From c7b55e5ad330ab6e7ed46523a8057136585c2ff8 Mon Sep 17 00:00:00 2001 From: Michiel Mulders Date: Tue, 23 Jan 2018 17:12:19 +0100 Subject: [PATCH] Fix note to top of readme --- .vscode/settings.json | 3 +++ examples/README.md | 22 +++++++++++----------- 2 files changed, 14 insertions(+), 11 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..e8c013f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "restructuredtext.confPath": "/home/michiel/projects/bigchaindb-driver/js-bigchaindb-driver" +} \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 5c9f194..efa3767 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,14 @@ +# Quick Notes +`dotenv` is listed as a dependencies in `package.json`. +If you want to use this, add a `.env` file to the root of this project (same level as this `README.md` file) +and replace the variables to fit your specific config. + +``` +BIGCHAINDB_API_PATH=http://localhost:9984/api/v1/ +BIGCHAINDB_APP_ID= +BIGCHAINDB_APP_KEY= +``` + # Usage `npm install` -> Installs all required dependencies to run these examples. @@ -13,14 +24,3 @@ **Seed/Keypair Functionality**: Create keypair with bip39 library. -> `npm run seed-func` - -## Notes -`dotenv` is listed as a dependencies in `package.json`. -If you want to use this, add a `.env` file to the root of this project (same level as this `README.md` file) -and replace the variables to fit your system. - -``` -BIGCHAINDB_API_PATH=http://localhost:9984/api/v1/ -BIGCHAINDB_APP_ID= -BIGCHAINDB_APP_KEY= -``` \ No newline at end of file