Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Suggestion: improve the README and show how the tool works in practice

See original GitHub issue

I’ve read the README and it’s very unclear how this library actually works – what goes in, what comes out, that sort of thing. Perhaps a link to a in the README.

Issue Analytics

  • State:open
  • Created 4 years ago
  • Reactions:9
  • Comments:5

github_iconTop GitHub Comments

ScottChapmancommented, Jul 7, 2020

totally agree here. There really needs to be even a VERY simple example.

jcollumcommented, Apr 27, 2020

I didn’t use it.

On Mon, Apr 27, 2020 at 9:30 AM Indraraj wrote:

@jcollum did you get how to use this pkg ?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe .

Read more comments on GitHub >

github_iconTop Results From Across the Web

README Best Practices - Tilburg Science Hub
Learn how to write a convincing and effective README file. Get to know the best practices with our examples and templates for GitHub...
Read more >
Essential Sections for Better Documentation of a README ...
README files are my entry points to “feeling out” new ...
Read more >
How to write a good README for your GitHub project?
Today we will focus on good practices of writing such a file - with a few examples, and a ready to use template....
Read more >
Intro to ReadMe - ReadMe Documentation
All of your documentation is written with our Markdown Editor. Learn more about how our Editor works here. If you're ready to jump...
Read more >
fatal: pathspec 'README.txt' did not match any files
You need to use another tool to do so. Use your favorite text editor (I suggest Notepad++, Sublime Text 3, or Atom) and...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found