Skip to content

Commit f7519e7

Browse files
committed
fix(docs): refactor and improve README
Improvements: * Add links. * Don't mark quick-lint-js up as code. Style refactors: * Word wrap at 80 columns. * Add blank line after headings.
1 parent ca67c64 commit f7519e7

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ quick-lint-js finds many bugs, including:
1313

1414
## Installing
1515

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

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

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

3032
## Examples
31-
Here are some common bugs that `quick-lint-js` can catch:
33+
34+
Here are some common bugs that quick-lint-js can catch:
3235

3336
### Example 1: Undefined Variable
37+
3438
```js
3539
const occupation = "Engineer";
3640
console.log("Welcome, " + ocupation); // Typo: 'ocupation' should be 'occupation'
3741
```
3842
Output: `use of undeclared variable: ocupation`
3943

4044
### Example 2: Reassigning a const variable
45+
4146
```js
4247
const name = "John";
4348
name = "Doe"; // Error: Cannot reassign a constant
4449
```
4550
Output: `assignment to const variable: name`
4651

4752
### Example 3: Using await in a non-async function
53+
4854
```js
4955
function getData() {
5056
await fetch("/data");
5157
}
5258
```
5359
Output: `await used in non-async function`
5460

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

5764
## Contributing
5865

59-
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.
66+
We’re always happy to welcome new contributors! If you’d like to contribute to
67+
quick-lint-js, please refer to the contributing guide on our website for all the
68+
details.
6069

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

6372
## Contact
73+
6474
If you have any questions or feedback, feel free to reach out:
6575

6676
- **Bugs and feature requests**: File an issue on GitHub.
67-
- **IRC**: Ask questions in the quick-lint-js channel on Libera.Chat.
68-
- **Security bug reports** (private disclosure): Email us at strager.nds@gmail.com
77+
- **IRC**: Ask questions in the [#quick-lint-js][quick-lint-js-irc-web] channel
78+
on Libera.Chat.
79+
- **Security bug reports** (private disclosure): Email us at
80+
[strager.nds@gmail.com](mailto:strager.nds@gmail.com).
81+
82+
[quick-lint-js-irc-web]: https://kiwiirc.com/nextclient/irc.libera.chat/#quick-lint-js

0 commit comments

Comments
 (0)