Npm readme (#836)
This commit is contained in:
44
npm-readme.md
Normal file
44
npm-readme.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# impress.js
|
||||
**What is impress.js?**
|
||||
|
||||
impress.js is a javascript framework that uses the power of CSS 3 transforms and transitions in today's browsers and is inspired by the idea behind [prezi.com](https://prezi.com).
|
||||
|
||||
**WARNING**
|
||||
|
||||
impress.js may not help you if you have nothing interesting to say ;)
|
||||
|
||||
|
||||
# How to use it
|
||||
Run `npm i impress.js` to get the framework or head to our GitHub page and follow the instructions in the [README](/README.md) there. You may also use one of the links provided down below to include the script directly from a cdn. *Note:* This might not always work, so if it doesn't, just download the file and put it into a folder on your hard drive.
|
||||
|
||||
## Direct links to only impress.js file
|
||||
- V2.0.0: https://cdn.jsdelivr.net/gh/impress/impress.js@2.0.0/js/impress.js
|
||||
- V1.1.0: https://cdn.jsdelivr.net/gh/impress/impress.js@1.1.0/js/impress.js
|
||||
- Source: https://cdn.jsdelivr.net/gh/impress/impress.js/js/impress.js
|
||||
|
||||
For older versions, please just replace the version number behind the @!
|
||||
|
||||
## Getting Started guide
|
||||
Alternative download instructions that are more exhaustive are also included in our new [Getting Started](/GettingStarted.md) file where you can also get an introduction to impress.js.
|
||||
|
||||
## Demos
|
||||
You can see a demo of the framework in action [here](https://impress.js.org). Additional examples may be found [here](https://impress.js.org/examples).
|
||||
|
||||
# Browser Support
|
||||
The design goal for impress.js has been to showcase awesome CSS3 features as found in modern browser versions. We also use some new DOM functionality, and specifically do not use jQuery or any other JavaScript libraries, nor our own functions, to support older browsers. In general, recent versions of Firefox and Chrome are known to work well. Reportedly IE now works too.
|
||||
|
||||
The typical use case for impress.js is to create presentations that you present from your own laptop, with a browser version you know works well. Some people also use impress.js successfully to embed animations or presentations in a web page, however, be aware that in this some of your visitors may not see the presentation correctly, or at all.
|
||||
|
||||
In particular, impress.js makes use of the following JS and CSS features:
|
||||
|
||||
- [DataSet API](http://caniuse.com/#search=dataset)
|
||||
- [ClassList API](http://caniuse.com/#search=classlist)
|
||||
- [CSS 3D Transforms](http://caniuse.com/#search=css%203d)
|
||||
- [CSS Transitions](http://caniuse.com/#search=css%20transition)
|
||||
|
||||
# COPYRIGHT AND LICENSE
|
||||
Copyright 2011-2016 Bartek Szopka
|
||||
|
||||
Copyright 2015-present Henrik Ingo
|
||||
|
||||
Released under the MIT [License](https://github.com/impress/impress.js/blob/HEAD/LICENSE)
|
||||
Reference in New Issue
Block a user