unpkg/docs/about.md

41 lines
2.2 KiB
Markdown
Raw Normal View History

unpkg is an [open source](https://github.com/unpkg) project built and maintained by [Michael Jackson](https://twitter.com/mjackson).
2016-05-20 18:58:58 +00:00
### Sponsors
2017-01-25 16:06:16 +00:00
The fast, global infrastructure that powers unpkg is generously donated by [Cloudflare](https://www.cloudflare.com) and [Heroku](https://www.heroku.com).
2016-05-20 18:58:58 +00:00
2016-06-18 19:54:01 +00:00
<div class="about-logos">
<div class="about-logo">
2018-04-29 02:09:15 +00:00
<a href="https://www.cloudflare.com"><img src="cloudflare-logo.png"></a>
2016-05-20 18:58:58 +00:00
</div>
2016-06-18 19:54:01 +00:00
<div class="about-logo">
2018-04-29 02:09:15 +00:00
<a href="https://www.heroku.com"><img src="heroku-logo.png"></a>
2016-05-20 18:58:58 +00:00
</div>
</div>
2016-05-20 19:20:23 +00:00
### Cache Behavior
2018-04-29 02:09:15 +00:00
The CDN caches files based on their permanent URL, which includes the npm package version. This works because npm does not allow package authors to overwrite a package that has already been published with a different one at the same version number.
2016-05-20 19:20:23 +00:00
URLs that do not specify a package version number redirect to one that does. This is the `latest` version when no version is specified, or the `maxSatisfying` version when a [semver version](https://github.com/npm/node-semver) is given. Redirects are cached for 5 minutes.
Browsers are instructed (via the `Cache-Control` header) to cache assets for 4 hours.
2016-05-20 18:58:58 +00:00
### Support
2016-08-25 21:30:55 +00:00
unpkg is a free, best-effort service and cannot provide any uptime or support guarantees.
2016-05-20 18:58:58 +00:00
I do my best to keep it running, but sometimes things go wrong. Sometimes there are network or provider issues outside my control. Sometimes abusive traffic temporarily affects response times. Sometimes I break things by doing something dumb, but I try not to.
2016-08-25 21:30:55 +00:00
The goal of unpkg is to provide a hassle-free CDN for npm package authors. It's also a great resource for people creating demos and instructional material. However, if you rely on it to serve files that are crucial to your business, you should probably pay for a host with well-supported infrastructure and uptime guarantees.
2016-05-20 18:58:58 +00:00
2016-08-25 21:30:55 +00:00
unpkg is not affiliated with or supported by npm, Inc. in any way. Please do not contact npm for help with unpkg.
2016-05-20 18:58:58 +00:00
### Abuse
unpkg maintains a list of packages that are known to be malicious. If you find such a package on npm, please let us know!
2016-05-20 18:58:58 +00:00
### Feedback
2018-04-29 02:09:15 +00:00
If you think this is useful, we'd love to hear from you. Please reach out to [@unpkg](https://twitter.com/unpkg) with any questions or concerns.