vocdoni/vocdoni-sdk

Improve documentation for the "createAccount" method

jpaulet opened this issue · 1 comments

In the documentation, only this documentation is provided:

const info = await client.createAccount()

Without any param. Improve the documentation by adding what the "createAccount()" can diggest, something like:

var metadata = { 
    "name": {
      "default": "Your org name",
    },
    "description": {
      "default": "This is the org description",
      "es": "La descripción de la org"
    },
    "twitter": {
      "default": "https://twitter.com/@orghandle",
    },
    "media": {
      "avatar": "ipfs://QmXxgLNRSeK6jtFkJ9TsL8nYxFnJ8RKa2xXHUFKGankX6k",
      "header": "ipfs://QmXxgLNRSeK6jtFkJ9TsL8nYxFnJ8RKa2xXHUFKGankX6k",
      "logo": "ipfs://QmXxgLNRSeK6jtFkJ9TsL8nYxFnJ8RKa2xXHUFKGankX6k"
    }
    #you can add more metadata here (links, webpage, docs, etc.)
}

const info = await client.createAccount(metadata)

Done in #114