packages/browserslist/README.md
# @terminal-nerds/browserslist-config ![package version badge] âĄī¸ **Extendable ![browserslist icon] [browserslist] configuration**, part of the[terminal-nerds/configs] project. [terminal-nerds/configs]: https://github.com/terminal-nerds/configs[package version badge]: https://img.shields.io/npm/v/@terminal-nerds/browserslist-config/latest?style=for-the-badge&logo=npm[browserslist]: https://github.com/browserslist/browserslist[browserslist icon]: https://api.iconify.design/logos/browserslist.svg[terminal-nerds/configs]: https://github.com/terminal-nerds/configs --- ## Prerequisites [![node.js version support badge]][node.js][![supported browserslist version badge]][browserslist] [node.js version support badge]: https://img.shields.io/node/v-lts/@terminal-nerds/browserslist-config?style=for-the-badge&logo=nodedotjs[supported browserslist version badge]: https://img.shields.io/github/package-json/dependency-version/terminal-nerds/configs/peer/browserslist-cli?filename=packages%2Fbrowserslist%2Fpackage.json&logo=markdown&style=for-the-badge âšī¸ This configuration package require these tools to use locally on yourdevice(s): 1. ![node.js icon] Latest [Node.js] LTS _(Long-Term Support)_ version1. One of Node.js package managers: - ![pnpm icon] [pnpm] - ![yarn icon] [yarn] - ![npm icon] [npm]1. Latest ![browserslist icon] [browserslist] version [node.js]: https://nodejs.org/en/[node.js icon]: https://api.iconify.design/logos/nodejs-icon.svg[pnpm]: https://pnpm.io/[pnpm icon]: https://api.iconify.design/vscode-icons/file-type-light-pnpm.svg[npm]: https://npmjs.com/[npm icon]: https://api.iconify.design/logos/npm-icon.svg[yarn]: https://yarnpkg.com/[yarn icon]: https://api.iconify.design/logos/yarn.svg --- ## Basic usage đŖ Follow the steps below: 1. **Install it with the ![node.js icon] [Node.js] package manager of your choice** _(in our case, we use ![pnpm icon] [pnpm])_. ```sh pnpm install --save-dev browserslist @terminal-nerds/browserslist-config ``` 1. **Create a ![browserslist icon] [browserslist configuration file] - `.browserslistrc`**. 1. **Extend one of this module package configuration.** ```txt # https://browsersl.ist/ extends @adchitects/browserslist-config/browsers ``` đ For the ![browserslist icon] [browserslist] usage, please refer to itsdocumentation. [browserslist configuration file]: https://github.com/browserslist/browserslist#browserslistrc[browserslist cli]: https://github.com/browserslist/browserslist#debug --- ## Available configurations [![Dependencies badge]][dependencies url] | Name | Purpose || ---------- | -------------------------------- || `browsers` | For the developing a browser app || `node` | For the developing a Node.js app |[dependencies badge]: https://img.shields.io/librariesio/release/npm/@terminal-nerds/browserslist-config?style=for-the-badge[dependencies url]: https://libraries.io/npm/@terminal-nerds%2Fbrowserslist-config --- ## Security [![workflow security badge]][security policy] đ For more information, please refer to the [Security section] at the root of the[terminal-nerds/configs] monorepo. [workflow security badge]: https://img.shields.io/github/actions/workflow/status/terminal-nerds/configs/maintenance.yml?label=Security&logo=github&style=for-the-badge&branch=main[security section]: https://github.com/terminal-nerds/configs#security[security policy]: https://github.com/terminal-nerds/configs/security/policy --- ## Contributing [![contributors badge]][contributors url] đ¤ **Contributions of any kind are welcome!** Please refer to the monorepo _([terminal-nerds/configs])_ project's[CONTRIBUTING file] for more information if you wish to get involved. [contributing file]: https://github.com/terminal-nerds/configs/blob/main/.github/CONTRIBUTING.md[contributors badge]: https://img.shields.io/github/contributors/terminal-nerds/configs?style=for-the-badge[contributors url]: https://github.com/terminal-nerds/configs#contributors --- ## License [![license badge]][license] âī¸ For more information, please refer to the [License section] at the root ofthe [terminal-nerds/configs] monorepo. [license badge]: https://img.shields.io/github/license/terminal-nerds/configs?style=for-the-badge[license]: https://github.com/terminal-nerds/configs/blob/main/LICENSE.md[license section]: https://github.com/terminal-nerds/configs#License