mirror of
https://github.com/encounter/yarn.git
synced 2026-03-30 11:43:44 -07:00
Sebastian McKenzie
58 lines
2.9 KiB
Markdown
58 lines
2.9 KiB
Markdown
<p align="center">
|
|
<a href="https://yarnpkg.com/">
|
|
<img alt="Yarn" src="https://github.com/yarnpkg/assets/blob/master/yarn-kitten-full.png?raw=true" width="546">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
Fast, reliable, and secure dependency management.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://travis-ci.org/yarnpkg/yarn"><img alt="Travis Status" src="https://travis-ci.com/yarnpkg/yarn.svg?token=DxqWAqRqs3zWAF8EhBHy"></a>
|
|
<a href="https://circleci.com/gh/yarnpkg/yarn"><img alt="Circle Status" src="https://circleci.com/gh/yarnpkg/yarn.svg?style=svg&circle-token=5f0a78473b0f440afb218bf2b82323cc6b3cb43f"></a>
|
|
<a href="https://ci.appveyor.com/project/yarnpkg/yarn/branch/master"><img alt="Appveyor Status" src="https://ci.appveyor.com/api/projects/status/rhcdj4980ccy7su3/branch/master?svg=true"></a>
|
|
<a href="https://discord.gg/yarnpkg"><img alt="Discord Chat" src="https://discordapp.com/api/guilds/226791405589233664/widget.png"></a>
|
|
</p>
|
|
|
|
---
|
|
|
|
**Fast:** Yarn caches every package it downloads so it never needs to again. It also parallelizes operations to maximize resource utilization so install times are faster than ever.
|
|
|
|
**Reliable:** Using a detailed, but concise, lockfile format, and a deterministic algorithm for installs, Yarn is able to guarantee that an install that worked on one system will work exactly the same way on any other system.
|
|
|
|
**Secure:** Yarn uses checksums to verify the integrity of every installed package before its code is executed.
|
|
|
|
## Features
|
|
|
|
* Offline Mode: If you've installed a package before, you can install it again without any internet connection.
|
|
* Deterministic: The same dependencies will be installed the same exact way across every machine regardless of install order.
|
|
* Network Performance: Yarn efficiently queues up requests and avoids request waterfalls in order to maximize network utilization.
|
|
* Multiple Registries: Install any package from either npm or Bower and keep your package workflow the same.
|
|
* Network Resilience: A single request failing won't cause an install to fail. Requests are retried upon failure.
|
|
* Flat Mode: Resolve mismatching versions of dependencies to a single version to avoid creating duplicates.
|
|
* More emojis. 🐈
|
|
|
|
## Installing Yarn
|
|
|
|
Read the [Installation Guide](https://yarnpkg.com/en/docs/install) on our website for detailed instructions on how to install Yarn on your operating system.
|
|
|
|
## Contributing to Yarn
|
|
|
|
Contributions are always welcome, no matter how large or small. Before contributing,
|
|
please read the [code of conduct](CODE_OF_CONDUCT.md).
|
|
|
|
See [Contributing](CONTRIBUTING.md).
|
|
|
|
## Prior art
|
|
|
|
Yarn wouldn't exist if it wasn't for excellent prior art. Yarn has been inspired by the following projects:
|
|
|
|
- [Bundler](https://github.com/bundler/bundler)
|
|
- [Cargo](https://github.com/rust-lang/cargo)
|
|
- [npm](https://github.com/npm/npm)
|
|
|
|
## Credits
|
|
|
|
Thanks to [Sam Holmes](https://github.com/samholmes) for donating the npm package name!
|