mathisonian / mathisonian/serve-folder
Documentation: Starting the server
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
It would be helpful to add a line to the README to demonstrate how to use this package. Just something like:
```
serve-folder path/to/folder/ 8080
```
Along the same lines, it'd be good to include a `--help` option or similar to list the available options.
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
Start with the README and the command's existing option handling. Add a usage example showing `serve-folder path/to/folder/ 8080`, and make the command's `--help` option list the available options. Done means both behaviors are documented and can be verified from the command line.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100