Skip to content

Commit 4ed5992

Browse files
author
Pete Cooper
committed
Branding
s/cdnJS/cdnjs
1 parent 46855aa commit 4ed5992

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[![Build Status](https://travis-ci.org/cdnjs/cdnjs.png?branch=master)](https://travis-ci.org/cdnjs/cdnjs) [![Dependency Status](https://david-dm.org/cdnjs/cdnjs.png?theme=shields.io)](https://david-dm.org/cdnjs/cdnjs) [![devDependency Status](https://david-dm.org/cdnjs/cdnjs/dev-status.png?theme=shields.io)](https://david-dm.org/cdnjs/cdnjs#info=devDependencies)
22

3-
# cdnJS Script Repository
3+
# cdnjs Script Repository
44

5-
[cdnJS](https://github.com/cdnjs/cdnjs) is the repository mirroring all scripts on `cdnjs.cloudflare.com`, created and maintained by [Thomas Davis](https://twitter.com/neutralthoughts), [Ryan Kirkman](https://twitter.com/ryan_kirkman) and [Pete Cooper](http://twitter.com/petecooper)
5+
[cdnjs](https://github.com/cdnjs/cdnjs) is the repository mirroring all scripts on `cdnjs.cloudflare.com`, created and maintained by [Thomas Davis](https://twitter.com/neutralthoughts), [Ryan Kirkman](https://twitter.com/ryan_kirkman) and [Pete Cooper](http://twitter.com/petecooper)
66

77
We will host any version of any library, subject to popularity and licence permissions.
88

@@ -14,11 +14,11 @@ Please raise a pull request for an older version of a library if your site still
1414

1515
## Adding a new or updating an existing library
1616

17-
cdnJS relies on user-submitted pull requests and automatic updating via `npm` to populate and update libraries. To add a new library, or update an existing library outside of `npm`, start by [forking the cdnJS repo](https://github.com/cdnjs/cdnjs/fork) to your own GitHub account.
17+
cdnjs relies on user-submitted pull requests and automatic updating via `npm` to populate and update libraries. To add a new library, or update an existing library outside of `npm`, start by [forking the cdnjs repo](https://github.com/cdnjs/cdnjs/fork) to your own GitHub account.
1818

1919
If you're adding/modifying outside of the GitHub browser interface, for example on the command line or with the GitHub desktop application, you will need to additionally install `node` locally. For more information on installing `node`, please refer to [nodejs.org](http://nodejs.org).
2020

21-
When you have forked the cdnJS repo, add your library to it. Libraries are stored in the `ajax/libs` directory. Each library has its own subdirectory of `ajax/libs` and each version of the library has its own subdirectory of the library directory name, for example:
21+
When you have forked the cdnjs repo, add your library to it. Libraries are stored in the `ajax/libs` directory. Each library has its own subdirectory of `ajax/libs` and each version of the library has its own subdirectory of the library directory name, for example:
2222

2323
```
2424
/ajax/libs/jquery/2.0.0/
@@ -30,7 +30,7 @@ You should consider the following when adding to or updating the library:
3030

3131
* Filenames should **not** include a version number and be **lowercase**. This is OK: `useful.min.js`, but this is not: `useful-2.0.1.min.js`.
3232

33-
* JavaScript & CSS files should be minified to reduce network and browser overhead. If the library doesn't already provide a minified version, cdnJS's preferred JavaScript minifier is [UglifyJS](http://marijnhaverbeke.nl/uglifyjs "UglifyJS")
33+
* JavaScript & CSS files should be minified to reduce network and browser overhead. If the library doesn't already provide a minified version, cdnjs's preferred JavaScript minifier is [UglifyJS](http://marijnhaverbeke.nl/uglifyjs "UglifyJS")
3434

3535
* If you are updating a library, please try to maintain consistency with the existing file and directory structure. There will be occasions, particularly with major version increments, where this is not practical. If there are significant changes in the file structure, please note this in your pull request.
3636

@@ -45,7 +45,7 @@ If you're updating the library outside of `npm` or the GitHub browser, you shoul
4545

4646
If you run `npm test` and see no errors, all is well; resolve any errors before you raise your pull request and re-run `npm test` to ensure everything works.
4747

48-
You may see a warning about a missing readme file - you can ignore this. Libraries on cdnJS do not require a readme file.
48+
You may see a warning about a missing readme file - you can ignore this. Libraries on cdnjs do not require a readme file.
4949

5050
## Pull request pre-flight checks
5151

@@ -68,13 +68,13 @@ Please include the following in your pull request:
6868
* How you found the version of the script (e.g., `Source: https://github.com/example/releases/1.2.3.zip`)
6969
* Evidence of popularity if the GitHub numbers don't indicate popularity.
7070

71-
Providing the origin of your files is very helpful as the cdnJS project is peer-reviewed.
71+
Providing the origin of your files is very helpful as the cdnjs project is peer-reviewed.
7272

7373
## Enabling `npm` auto update
7474

7575
__We are currently in the process of converting as many libraries to NPM auto update as possible. For a bit of fun, cdnjs will send you **$5 USD in Bitcoin for each library you convert to NPM auto-update**. If you could tag your pull request with [BC] and throw your Bitcoin address in the commit, we will send your payment through as soon as possible. If you would like to keep your BC address private, send an email to thomasalwyndavis@gmail.com with the details.__
7676

77-
cdnJS automatically updates libraries that are known to be hosted on `npm` e.g., Lodash. This auto-update script runs every 15 minutes.
77+
cdnjs automatically updates libraries that are known to be hosted on `npm` e.g., Lodash. This auto-update script runs every 15 minutes.
7878

7979
To add an `npm` hook to a library, update the `package.json` with configuration details and submit your pull request. An example configuration:
8080

@@ -89,7 +89,7 @@ To add an `npm` hook to a library, update the `package.json` with configuration
8989
```
9090

9191
* `npmName` should map to the name of the library on `npm`
92-
* `npmFileMap` is a list of files to take from the `npm` tarball and host on cdnJS
92+
* `npmFileMap` is a list of files to take from the `npm` tarball and host on cdnjs
9393
* `basePath` will be ignored when copying over to the CDN
9494
* `files` is a pattern matcher allowing selection of multiple files
9595

@@ -109,7 +109,7 @@ The above example looks in the tarball whose structure might look like this:
109109
|__README.md
110110
```
111111

112-
The auto-update process will look for `dist` inside the named tarball and copy all the JavaScript file to cdnJS, minus the `dist` path. The resulting files in cdnJS will be:
112+
The auto-update process will look for `dist` inside the named tarball and copy all the JavaScript file to cdnjs, minus the `dist` path. The resulting files in cdnjs will be:
113113

114114
```
115115
|__ajax
@@ -128,13 +128,13 @@ The auto-update process will look for `dist` inside the named tarball and copy a
128128

129129
## API
130130

131-
You can search cdnJS via our API:
131+
You can search cdnjs via our API:
132132

133133
```
134134
http://api.cdnjs.com/libraries
135135
```
136136

137-
Without any query parameters it will return the name and main file URL of every library on cdnJS. To search, use:
137+
Without any query parameters it will return the name and main file URL of every library on cdnjs. To search, use:
138138

139139
```
140140
http://api.cdnjs.com/libraries?search=jquery

0 commit comments

Comments
 (0)