Add soms user scenario samples please
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 16.6k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
Hi, its hard to understand what chisel does and does not do.
Is it possible to add some user scenario examples on the readme please?
If I understand correctly you can use chisel to:
- set up a proxy on the internet that allows you to connect to ports your firewall blocks
- set up your own socks proxy on the internet somewhere so you can make connections to internet sites that you are not allowed to go to by a firewall
You cannot use chisel to:
- remotely login into a desktop say on your work behind corporate firewall, like you can with logmein hamachi or other remote login services
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the current README and the requested proxy, SOCKS proxy, and remote-login scenarios in this issue. Add clear user scenario examples and limitations to the README, then verify that it accurately explains what chisel can and cannot do.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100