minor README corrections.

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Open the README and locate the sections describing the color attribute and initialization. Verify those examples against the documented API, then correct the attribute to logColor and show initialization with an object rather than an array. Done means both README corrections are present and the examples remain consistent.

Written by the indexing model from the issue text.

Description

README: color attribute is wrong; it should be logColor.
README: on init, you should use object instead array

Dominant language
JavaScript
Stars
854
Forks
71
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 chinchang/screenlog.js

All issues in chinchang/screenlog.js

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.