Skip to content

Commit

Permalink
Copy-edit README.md Issue: cdnjs#11168
Browse files Browse the repository at this point in the history
  • Loading branch information
@LeaSak
LeaSak committed Nov 5, 2017
1 parent 9585662 commit 6741080
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
View file
Expand Up @@ -14,7 +14,7 @@
## Table of Contents

- [Introduction](#introduction)
- [latest version url support](#latest-version-url-support)
- [latest version URL support](#latest-version-url-support)
- [Contributing](#contributing)
- [API usage](#api-usage)
- [Extensions, Plugins, Resources](#extensions-plugins-resources)
Expand All @@ -26,35 +26,35 @@

## Introduction

This is the main repository to maintain the libraries' assets on CDNJS. For website and API, please refer to [new-website](https://github.com/cdnjs/new-website) repository, all the repositories can be found at [CDNJS](https://github.com/cdnjs/) organization on GitHub!
This is the main repository to maintain the libraries' assets on CDNJS. For our website and API, please refer to the [new-website](https://github.com/cdnjs/new-website) repository. You can find all repositories at [CDNJS](https://github.com/cdnjs/) on GitHub!

CDNJS is a free and open source project to organize all the famous web front-end development resources and provide them to the developers with faster CDN infrastructure without usage limitation and fee. We want to help individual library/framework developers spread their projects, and help web developers to supercharge their websites! With the great and free CDN service, developers can focus on the project and website development, without spending time worrying about how to setup a CDN for the project or website assets. We hope to make web development easier, your websites and the WWW faster and safer.
CDNJS is a free and open source project to organize and provide popular front-end web development resources to developers via a fast CDN infrastructure without usage limitations and fees. We want to help individual library/framework developers distribute their projects, and web developers supercharge their websites! With our great free CDN service, developers can focus on their projects and website development. Developers no longer have to spend time worrying about how to set-up a CDN for projects or website assets. We hope to make web development easier, as well as your websites and the WWW faster and safer.

If you love 💖 what we are doing and would like to help us make the project better, please consider to:
If you love 💖 what we are doing and would like to help us make the project better, please consider the following options:

1. Become a contributor, help us write [document](https://github.com/cdnjs/cdnjs/tree/master/documents), organize [issues](https://github.com/cdnjs/cdnjs/issues), add libraries, design the [website](https://github.com/cdnjs/new-website), propose features, review [issues](https://github.com/cdnjs/cdnjs/issues) and [pull requests](https://github.com/cdnjs/cdnjs/pulls), etc.
2. Donate us on [Gratipay](https://gratipay.com/cdnjs/), [Bountysource](https://www.bountysource.com/teams/cdnjs) or [Tip4Commit](https://tip4commit.com/github/cdnjs/cdnjs).
1. Become a contributor. Help us write [documentation](https://github.com/cdnjs/cdnjs/tree/master/documents), organize [issues](https://github.com/cdnjs/cdnjs/issues), add libraries, design our [website](https://github.com/cdnjs/new-website), propose features, review [issues](https://github.com/cdnjs/cdnjs/issues) and [pull requests](https://github.com/cdnjs/cdnjs/pulls), etc.
2. Donate to us on [Gratipay](https://gratipay.com/cdnjs/), [Bountysource](https://www.bountysource.com/teams/cdnjs), or [Tip4Commit](https://tip4commit.com/github/cdnjs/cdnjs).

We really appreciate your help 😊
We really appreciate your help. 😊

Currently, CDNJS is the top 2([ref](https://w3techs.com/technologies/overview/content_delivery/all)) web front-end CDN service with great performance. We fully support [https](https://en.wikipedia.org/wiki/HTTPS), [SPDY](https://en.wikipedia.org/wiki/SPDY), [http/2.0](https://http2.github.io/) and [SRI](https://www.w3.org/TR/SRI/), which will **boost** and **secure** your website with zero configuration. *(note that you'll still need to take care of the server side and application layer of security issues. We make it better, but can't help too much if you implement a bad practice)*
Currently, CDNJS is rated No. 2 ([ref](https://w3techs.com/technologies/overview/content_delivery/all)) in web front-end CDN services and has great performance. We fully support [https](https://en.wikipedia.org/wiki/HTTPS), [SPDY](https://en.wikipedia.org/wiki/SPDY), [http/2.0](https://http2.github.io/), and [SRI](https://www.w3.org/TR/SRI/). These will **boost** and **secure** your website with zero configuration. *(Note: You'll still need to take care of server-side and application layer security issues. We make it better, but we can't help you too much if you implement a bad practice.)*

## latest version url support
## latest version URL support

Note that we don't support the feature to use `latest` in the url, because of the reasons below:
Note that we don't support the feature to use `latest` in the URL because of the reasons below:

1. It brings potential risks to break the website if there is any compatible issue or bug coming from upstream. It's not a good idea to use it in the production environment, both jQuery CDN and Google CDN don't provide this feature.
2. The `latest` url feature also has cache and performance issues, which has conflicts of what we are trying to do - make your website load as fast as possible.
3. Security issues become more and more important nowadays, for example, GitHub had been attacked by the Great Cannon via malicious JavaScript([ref1](https://citizenlab.org/2015/04/chinas-great-cannon/), [ref2](https://arstechnica.com/security/2015/04/meet-great-cannon-the-man-in-the-middle-weapon-china-used-on-github/)) during April 2015, one of the techniques to prevent this kind of attack is [Subresource Integrity(SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity). We have been supporting this feature for a long time, but the `latest` url feature totally conflicts with the SRI technique.
1. Your website might break if there are any compatibility issues or bugs coming from upstream. It's not a good idea to use it in the production environment. Both jQuery CDN and Google CDN don't provide this feature.
2. The `latest` URL feature also has cache and performance issues. This conflicts with what we are trying to do - make your website load as fast as possible.
3. Security issues have become more and more important nowadays. For example, Great Cannon attacked GitHub via malicious JavaScript ([ref1](https://citizenlab.org/2015/04/chinas-great-cannon/), [ref2](https://arstechnica.com/security/2015/04/meet-great-cannon-the-man-in-the-middle-weapon-china-used-on-github/)) during April 2015. One of the techniques to prevent this kind of attack is [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity). We have been supporting this feature for a long time. The `latest` URL feature, however, totally conflicts with the SRI technique.

## Contributing

To contribute to CDNJS, please refer to the [CONTRIBUTING.md](https://github.com/cdnjs/cdnjs/blob/master/CONTRIBUTING.md), it should contain most of the things you'll need to get your contribution started!
To contribute to CDNJS, please refer to [CONTRIBUTING.md](https://github.com/cdnjs/cdnjs/blob/master/CONTRIBUTING.md). It should contain most of the things you'll need to get your contribution started!

**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
**Working on your first Pull Request?** Learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

## API usage
See the [API page](https://cdnjs.com/api) on the website or [documents/api.md](documents/api.md);
See the [API page](https://cdnjs.com/api) on our website or read: [documents/api.md](https://github.com/cdnjs/cdnjs/blob/master/documents/api.md)

## Extensions, Plugins, Resources

Expand All @@ -75,7 +75,7 @@ or [gitstats](https://github.com/cdnjs?utf8=✓&q=gitstats), [git_stats](https:/

## Sponsors

CDNJS would never be successful without the kindness sponsoring from the sponsors, CDNJS is currently being sponsored by these companies:
CDNJS wouldn't be the success that it is today without our sponsors' kind support. These companies currently support CDNJS:

- [Cloudflare](https://www.cloudflare.com/?utm_source=cdnjs&utm_medium=link&utm_campaign=cdnjs)
- [DigitalOcean](https://www.digitalocean.com/?utm_source=cdnjs&utm_medium=link&utm_campaign=cdnjs)
Expand All @@ -85,4 +85,4 @@ CDNJS would never be successful without the kindness sponsoring from the sponsor
If you are interested in becoming a sponsor, please feel free to contact us!

## License
Each library is released under its own license, this CDNJS main repository is under [MIT license](LICENSE)
Each library is released under its own license. This CDNJS repository is published under [MIT license](LICENSE).

0 comments on commit 6741080

Please sign in to comment.