From 1689537f22a2f4cacfcf6dae3080c1638c63885c Mon Sep 17 00:00:00 2001 From: Atanas Atanasov Date: Sat, 27 Apr 2019 15:13:50 +0300 Subject: [PATCH 01/11] Add support for TypeScript --- README.md | 18 ++++- package.json | 7 +- ts/animate.me.d.ts | 33 ++++++++++ ts/animate.me.ts | 159 +++++++++++++++++++++++++++++++++++++++++++++ yarn.lock | 5 ++ 5 files changed, 219 insertions(+), 3 deletions(-) create mode 100644 ts/animate.me.d.ts create mode 100644 ts/animate.me.ts diff --git a/README.md b/README.md index 13bf532..6e0e262 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ or just use it as a good old `` tag. ### Usage note: -If you are using the ` ``` -or - -Include it from Unpkg CDN - -```html - -``` - ## Usage In your HTML create the elements that you want to be animated. @@ -61,6 +53,10 @@ Then ```javascript import AnimateMe from 'animateme'; + +// or + +import { AnimateMe } from 'animateme'; ``` and create a new instance with the default settings @@ -92,30 +88,9 @@ or just use it as a good old `` tag. **Note** -If you're not using a module bundler and are importing the JS file using a ` - new AnimateMe(); - - + + From 62f527b685798fca7f2c22de4f725b07299fb83e Mon Sep 17 00:00:00 2001 From: Atanas Atanasov Date: Wed, 27 Nov 2019 15:35:30 +0200 Subject: [PATCH 08/11] Update README --- README.md | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index cc7019c..3c9c139 100644 --- a/README.md +++ b/README.md @@ -19,30 +19,18 @@ You have the freedom to implement your own animations, use predefined (via anoth There are no dependencies and the library is ready to be used in any environment. -If you, however, wish to develop the library, extend it, fix it, etc, you need to install its development dependencies. +If you, however, wish to develop the library, extend it, fix it, etc, you need to fork this repository and install its development dependencies. ## Install ```sh npm i animateme -``` -or +# or -```sh yarn add animateme ``` -or - -Just download this repository and link the files located in dist folder: - -```html - - - -``` - ## Usage In your HTML create the elements that you want to be animated. @@ -120,7 +108,7 @@ Using `AnimateMe` via a good old `