Skip to content

Commit

Permalink
fix(docs): refactor and improve README
Browse files Browse the repository at this point in the history
Improvements:

* Add links.
* Don't mark quick-lint-js up as code.

Style refactors:

* Word wrap at 80 columns.
* Add blank line after headings.
  • Loading branch information
strager committed Sep 28, 2024
1 parent ca67c64 commit f7519e7
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ quick-lint-js finds many bugs, including:

## Installing

There are many ways to install `quick-lint-js`, depending on how you prefer to work! Here are the environments we support:
There are many ways to install quick-lint-js, depending on how you prefer to
work! Here are the environments we support:

- CLI (Command-Line Interface)
- LSP (Language Server Protocol)
Expand All @@ -25,44 +26,57 @@ There are many ways to install `quick-lint-js`, depending on how you prefer to w
- Emacs
- Kate

For detailed installation instructions, visit the [quick-lint-js installation guide](https://quick-lint-js.com/install/).
For detailed installation instructions, visit the [quick-lint-js installation
guide](https://quick-lint-js.com/install/).

## Examples
Here are some common bugs that `quick-lint-js` can catch:

Here are some common bugs that quick-lint-js can catch:

### Example 1: Undefined Variable

```js
const occupation = "Engineer";
console.log("Welcome, " + ocupation); // Typo: 'ocupation' should be 'occupation'
```
Output: `use of undeclared variable: ocupation`

### Example 2: Reassigning a const variable

```js
const name = "John";
name = "Doe"; // Error: Cannot reassign a constant
```
Output: `assignment to const variable: name`

### Example 3: Using await in a non-async function

```js
function getData() {
await fetch("/data");
}
```
Output: `await used in non-async function`

These are just a few examples of how `quick-lint-js` can help identify common issues in your JavaScript code.
These are just a few examples of how quick-lint-js can help identify common
issues in your JavaScript code.

## Contributing

We’re always happy to welcome new contributors! If you’d like to contribute to `quick-lint-js`, please refer to the contributing guide on our website for all the details.
We’re always happy to welcome new contributors! If you’d like to contribute to
quick-lint-js, please refer to the contributing guide on our website for all the
details.

Check out the [contributing guide here](https://quick-lint-js.com/contribute/).

## Contact

If you have any questions or feedback, feel free to reach out:

- **Bugs and feature requests**: File an issue on GitHub.
- **IRC**: Ask questions in the quick-lint-js channel on Libera.Chat.
- **Security bug reports** (private disclosure): Email us at [email protected]
- **IRC**: Ask questions in the [#quick-lint-js][quick-lint-js-irc-web] channel
on Libera.Chat.
- **Security bug reports** (private disclosure): Email us at
[[email protected]](mailto:[email protected]).

[quick-lint-js-irc-web]: https://kiwiirc.com/nextclient/irc.libera.chat/#quick-lint-js

0 comments on commit f7519e7

Please sign in to comment.