question-mark
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.

Some readme improvements

See original GitHub issue
  • let’s rework the headers so that instead of “install from NPM” it’s “load via import or require” and “install from CDN” it’s “load via <script> tag” which I think is more helpful.
  • let’s move the MathJax section up out of the Documentation section into the script-tag/CDN section and separately document how to use it with import/require
  • let’s create a separate LOCALIZATION.md (i.e. move it out of the dist readme) which explains how localization works, and includes information about how to load them via import/require as well as script tags

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:9 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
alexcjohnsoncommented, Jun 4, 2021

The key distinction is whether it’s an independent <script> tag or part of your build pipeline. So how about “Load via <script> tag” vs “Load as a node module”? I think users that don’t know what a node module is will recognize that they should use the script tag, and those that have a build pipeline will understand both.

0reactions
archmojcommented, Jun 4, 2021

The key distinction is whether it’s an independent <script> tag or part of your build pipeline. So how about “Load via <script> tag” vs “Load as a node module”? I think users that don’t know what a node module is will recognize that they should use the script tag, and those that have a build pipeline will understand both.

Applied in #5713.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Some README.md Love: Markdown Support Improvements
This post outlines some of the recent improvements for working with Markdown files in IntelliJ-based IDEs. For detailed instructions about these ...
Read more >
How to Write a Good README File for Your GitHub Project
From research and studying various README files, for sure there are some best practices that I have found. And that's what I will...
Read more >
Improvement-Proposals/README.md at master
The purpose of OriginTrail's Improvement Proposals repository is to enable structured submitting of an idea or any kind of improvement suggestion.
Read more >
Essential Sections for Better Documentation of a README ...
It states that it is the documentation of some Fortran ...
Read more >
How to Create the Perfect README for Your Open Source ...
Nice tool but i think we need some UI improvements, what do you think? 1 ...
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 Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found