need more contents in readme

Open Beginner friendly
#51 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Update the keystore README, using the codechain-primitives-js README as a reference. Add installation instructions, describe the API functions, and document how to run the test suite with yarn test. Done means the README covers all three topics and the stated test command works.

Written by the indexing model from the issue text.

Description

Unlike codechain-primitives-js,
keystore readme lacks installing package, API functions and how to test(yarn test).

Dominant language
TypeScript
Stars
14
Forks
7
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CodeChain-io/codechain-keystore-js

All issues in CodeChain-io/codechain-keystore-js

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.