Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Jun 1, 2024
1 parent 1e9a85c commit 15980fd
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

> Global identifiers from different JavaScript environments
It's just a [JSON file](globals.json), so use it in any environment.
It's just a [JSON file](globals.json), so you can use it in any environment.

This package is used by ESLint.

**This package [no longer accepts](https://github.com/sindresorhus/globals/issues/82) new environments. If you need it for ESLint, just [create a plugin](http://eslint.org/docs/developer-guide/working-with-plugins#environments-in-plugins).**
This package is used by ESLint 8 and earlier. For ESLint 9 and later, you should depend on this package directly in [your ESLint config](https://eslint.org/docs/latest/use/configure/language-options#predefined-global-variables).

## Install

Expand All @@ -17,7 +15,7 @@ npm install globals
## Usage

```js
const globals = require('globals');
import globals from 'globals';

console.log(globals.browser);
/*
Expand All @@ -36,7 +34,7 @@ Each global is given a value of `true` or `false`. A value of `true` indicates t
For Node.js this package provides two sets of globals:

- `globals.nodeBuiltin`: Globals available to all code running in Node.js.
These will usually be available as properties on the `global` object and include `process`, `Buffer`, but not CommonJS arguments like `require`.
These will usually be available as properties on the `globalThis` object and include `process`, `Buffer`, but not CommonJS arguments like `require`.
See: https://nodejs.org/api/globals.html
- `globals.node`: A combination of the globals from `nodeBuiltin` plus all CommonJS arguments ("CommonJS module scope").
See: https://nodejs.org/api/modules.html#modules_the_module_scope
Expand Down

0 comments on commit 15980fd

Please sign in to comment.