Skip to main content

Example Getting Started File

Required Prior Knowledge​

You should list any knowledge the user requires to properly understand your project, and it's source code and examples. For example:

Prerequisites​

You should list any software and hardware requisites to run the project in this subsection, ideally with a link to the official installation instructions. For example:

Install the Project​

You should use this subsection to give the user concrete and concise instructions on how to install the project. Ideally, these should be very short, and if an in depth explanation is required to install extensions or non-essential software you should address it in the How Tos or Tutorials folders.

NPM Install Example​

npm install @iota/client-wasm

Yarn Install Example​

yarn add @iota/client-wasm

Use the Project​

You should use this subsection to provide the users with the simplest possible example in which they can use the project after installing it, as well as minimal explanations if required. Keep in mind that as in the Install the Project subsection, complex use cases should be addressed in the How Tos or Tutorials. For example:

NodeJS Usage Example​

const iota = require('@iota/client-wasm/node');

async function main() {
  // Get the nodeinfo
  let iota_client = await iota.Client.withNode(
    'https://api.lb-0.h.chrysalis-devnet.iota.cafe/',
  );
  console.log('Nodeinfo: ', await iota_client.getInfo());
}
main();