Could use a one sentance explanation at the top of the README.

Open Beginner friendly
#159 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start at the opening of README and review the existing first sentence and surrounding introduction. Replace or revise it so newcomers understand what LiveReload does and who it is useful for; done means the README begins with a clear one-sentence explanation.

Written by the indexing model from the issue text.

Description

"This is a brand new LiveReload in version 2.0.0" doesn't explain much to the newcomer, though might be useful information .

It would be good if the first sentence in the README explained what livereload does + is useful for.

Some things I'm not sure of - is livereload just for web apps, just for wsgi apps ... I guess it runs specified actions when files are modified and updates the browser ?

Dominant language
Python
Stars
1.1k
Forks
146
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 lepture/python-livereload

All issues in lepture/python-livereload

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.