CSUB-256: Document Creditcoin-JS

[pLabarta]

Description of proposed changes

CONSIDER BEFORE MERGING: Until the package is published in NPM, installation guide will be misguiding

This PR:

• Removes the alpha warning from README
• Adds a simple installation guide (which asumes creditcoin-js is published on npm unscoped)
• Adds docs on how to build augmented types
• Adds usage examples to the README
• Adds additional working full examples to the example folder

This PR does not:

• Add testing of the examples to CI/integration-tests
• Add any logic to publish to NPM

---

Practical tips for PR review & merge:

• All GitHub Actions report PASS
• Newly added code/functions have unit tests
  • Coverage tools report all newly added lines as covered
  • The positive scenario is exercised
  • Negative scenarios are exercised, e.g. assert on all possible errors
  • Assert on events triggered if applicable
  • Assert on changes made to storage if applicable
• Modified behavior/functions - try to make sure above test items are covered
• Integration tests are added if applicable/needed

[codecov-commenter]

Codecov Report

Merging #1348 (c125492) into dev (d7dddc4) will decrease coverage by 0.66%.
Report is 13 commits behind head on dev.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev    #1348      +/-   ##
==========================================
- Coverage   70.83%   70.17%   -0.66%     
==========================================
  Files         107      107              
  Lines       12411    12506      +95     
  Branches      120      120              
==========================================
- Hits         8791     8776      -15     
- Misses       3610     3730     +120     
+ Partials       10        0      -10     

see 13 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[github-actions]

For full LLVM coverage report click here!

[atodorov]

CONSIDER BEFORE MERGING: Until the package is published in NPM, installation guide will be misguiding

Converted to Draft to avoid merging accidentally before we're sure we want to do this (or publish the package to NPM in the mean time).

[atodorov]

Some suggestions and change requests added.

[atodorov]

Don't we install typescript with yarn ?

I would add yarn as a requirement here tool.

[atodorov]

What about TypeScript being listed as prerequisite? I think it will be installed by yarn so no need to mention it explicitly, no ?

[atodorov]

That's a bit ambiguous (the tx variable I mean). I had to scroll back and read the example above to figure out that both snippets are connected.

Maybe highlight this connection somehow. A big fat warning or a full example with individual sections as comments is the only thing I can think off. The latter having the benefit that we can move it into a file and exercise it via CI.

[atodorov]

Suggested change

	### Preqrequisites
	### Prerequisites

[atodorov]

Given the hard-coded address below I think this only needs to be executed when running against a local network. You can use describeIf and/or testIf from ../utils and make execution conditional based on the URL for example.

Then you can remove the usage of global config values from the example itself.