refactor README

[ignaciopenia]

This PR includes minor fixes to the readme.
Also modified typedoc in package.json.

[tenuki]

@bolasblack reviewed and merged changes you sent to our repo.

We still have some basic concerns: the generated docs format displays some non-existing or not-accessible objects on the left column (lib hierarchy sections).

1. there exists a library component supposed to be accessible called bitcoinHelpers which, in my opinion doesn't appears to be available. (see below capture 1 trying to access from ts-node and capture 2 for access from node).
2. On the same left-column there appears the index element which in practice is hidden from user.
3. What we understand that is available for the user is what hangs below that index element.

Seen that, I think we should try to remove definitions in entrypoint and try to go with typedoc src/index.ts..

If you want merge this one and we then can change the typedoc issue tomorrow.

capture 1

> import{ bitcoinHelpers } from '@xlink-network/xlink-sdk';
<repl>.ts:4:9 - error TS2305: Module '"@xlink-network/xlink-sdk"' has no exported member 'bitcoinHelpers'.

4 import{ bitcoinHelpers } from '@xlink-network/xlink-sdk';
          ~~~~~~~~~~~~~~

capture 2

$ node
Welcome to Node.js v20.8.0.
Type ".help" for more information.
> mod = require( "@xlink-network/xlink-sdk")
{
  EVMContractType: [Getter],
  InvalidMethodParametersError: [Getter],
  KnownChainId: [Getter],
  KnownTokenId: [Getter],
  UnsupportedBridgeRouteError: [Getter],
  UnsupportedChainError: [Getter],
  UnsupportedContractAssignedChainIdError: [Getter],
  XLinkSDK: [Getter],
  XLinkSDKErrorBase: [Getter],
  toSDKNumberOrUndefined: [Getter]
}
> mod.
mod.__proto__                                mod.constructor                              mod.hasOwnProperty
mod.isPrototypeOf                            mod.propertyIsEnumerable                     mod.toLocaleString
mod.toString                                 mod.valueOf

mod.EVMContractType                          mod.InvalidMethodParametersError             mod.KnownChainId
mod.KnownTokenId                             mod.UnsupportedBridgeRouteError              mod.UnsupportedChainError
mod.UnsupportedContractAssignedChainIdError  mod.XLinkSDK                                 mod.XLinkSDKErrorBase
mod.__esModule                               mod.toSDKNumberOrUndefined

[bolasblack]

1. there exists a library component supposed to be accessible called bitcoinHelpers which, in my opinion doesn't appears to be available. (see below capture 1 trying to access from ts-node and capture 2 for access from node).

Hi @tenuki , that's a good question, if you can install this package in any other project, you can try like this:

if users are using the legacy version of nodejs, they can write require('@xlink-network/xlink-sdk/lib/bitcoinHelpers')

On the same left-column there appears the index element which in practice is hidden from user.

Yes, but I have no better idea how to deal with it, if we need to export multiple endpoints in the future. And I guess users would understand it (since nodejs will respect index.js as the default entrypoint of a module)