Getting Started: installation

⚠️ Have you read the two pages before? If not, you should because I won't get back on what I said and these pages are SUPER important to understand DisplayJS, so definitely go check 😊.

Build files

Before installing DisplayJS, you need to know that DisplayJS comes in 4 different builds:

• display.js : not-minified - written in normal JavaScript | Most heavyweight file
• display.min.js : minified - written in normal JavaScript | Lightweight file
• display.es6.js : not-minified - written in ECMAScript 6+, optimized for modern browsers | Most heavyweight file
• display.es6.min.js : minified - written in ECMAScript 6+, optimized for modern browsers | Most lightweight file

Installation

There are multiple ways of installing DisplayJS. Here are some by category:

• Package manager

NPM:

$ npm install display.js

Yarn:

$ yarn add display.js

Bower:

$ bower install display.js

• CDN

Currently, we have only 3 official CDNs, if you guys want DisplayJS another cdn, just send a mail to them because we currently don't have enough stars ⭐️ on GitHub.

UNPKG - Always the latest version / easier to work with

<script src="https://unpkg.com/display.js"></script>

jsDelivr - Always the latest version

<script src="https://cdn.jsdelivr.net/npm/display.js"></script>

CDNJS - By far the fastest / best for production

// Make sure to change the version                              v
<script src="https://cdnjs.cloudflare.com/ajax/libs/DisplayJS/1.0.0/display.min.js"></script>

• Alternatives

Download the repo:

$ git clone https://github.com/arguiot/DisplayJS

OR

Download files from the releases

Then:

After installing DisplayJS, read the basic page 😊.