canonical / canonical/chisel

Improve README

Open
#15 1 comment 9 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
424
Forks
65
Avg merge
12d 19h
Merged PRs (30d)
1

Description

I came across `chisel` today. It looks like an exciting tool, but unfortunately the README doesn't make it very clear what its purpose is.

Could you please expand the README? Some suggestions:

* Start with an overview of what the tool is
* Give some examples of usage with explanations of what the commands do
* Define any new terms you've invented (e.g. I see mention of `slice` but it's not very clear what that term means here)
* Compare to similar projects in the space, noting when you might use the other project or when you might use `chisel`

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the existing README and exploring chisel's usage so the overview, examples, terminology, and comparison are accurate. Done means the README explains the tool's purpose, demonstrates commands with explanations, defines terms such as “slice,” and describes when similar projects may be preferable.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.