Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.81 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.81 KB
Raw

browserslist-config

The GitHub browserslist config.

How is this used on GitHub?

We use browserslist to power tools that guide developers to use APIs and syntax that is implemented by the browsers we support. These tools include eslint-plugin-compat, eslint-plugin-escompat and postcss-preset-env.

Usage

Install the package using npm.

npm install --save-dev @github/browserslist-config

Note: If your project is setup to pull from GitHub Package Registry (GPR), then you will need to install the following way:

npm install --save-dev @github/browserslist-config --@github:registry=https://registry.npmjs.org

However, if possible, it is recommended to use NPM instead of GPR.

Add the browserslist key to your package.json.

diff --git a/package.json b/package.json
index 2ecef3d..260838f 100644
--- a/package.json
+++ b/package.json
@@ -5,6 +5,7 @@
   "keywords": [
     "prettier"
   ],
+  "browserslist": "extends @github/browserslist-config",
   "license": "MIT",
   "author": "GitHub Inc.",
   "main": "index.js"

Check out the browserslist documentation for more info on sharing configurations.

Contributing

Contributing should only be done by GitHub staff and PRs are approved by @github/web-systems as the CODEOWNERS of this library. GitHub Staff can use github/browser-support-cli to get production data on browser usage for github.com.

License

Distributed under the MIT license. See LICENSE for details.