diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 381a141..335cd3e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -13,7 +13,7 @@ git clone ... cd letterloading ``` -- Install all required dependencies. But before you do, ensure node is installed on your PC. OK +- Install all required dependencies. But before you do, ensure node is installed on your PC. OK ? ``` npm install @@ -26,8 +26,13 @@ Start breaking the library, npm start ``` -## If you just added some cool stuff, or just deducted some ugly stuff +## If you just added some cool stuff, or deducted some ugly stuff +- check out your stuff on your browser firstly, by using -- Create a repo and add the new letterloading +`npm run build` + +on your terminal. Then try to see the resulting changes on your devserver. + +- If you've done the above, YAY!!! You can now create a repo and add the new letterloading - Tell us you made some cool stuff as clear as possible - We will love your contributions diff --git a/README.md b/README.md index 1062702..df8a25c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ LetterLoading js is a javascript library for making awesome letter simulations. # Core concepts of LetterLoading. - **flexibility:** -This is because it is intended from ground up to do than just loading letter simulation. It could be extended to achieve even more animation simulation. +This is because it is intended from ground up to do than just loading letter simulation. It could be extended to achieve even more animation simulation (this feature is currently work in progress). - **robustness:** LetterLoading gives you the possibility to break it and achieve even more simulation. @@ -14,7 +14,7 @@ LetterLoading gives you the possibility to break it and achieve even more simula You can use LetterLoading as a - script tag from CDN ``` -https://unpkg.com/letterloading@1.0.2/library/letterloading.js +https://unpkg.com/letterloading@1.0.3/library/letterloading.js ``` - install from NPM @@ -80,7 +80,7 @@ export default LetterLoader; The purpose of LetterLoading Library is to make minimal and yet robust imaginative animations and simulations to letters or strings. -We aim to provide ready to use library to provide all sort of letter animations. Therefore, to achieve this big aims your contribution is always welcomed. We are open source. +We aim to provide ready to use library to provide all sort of letter animations. But this is work in progress and the plan may seem slow for now. However, to achieve these big aims your contribution is always welcomed. We are open source. Read below to learn how you can be a part of improving LetterLoading js. diff --git a/assets/demo.js b/assets/demo.js index 8a43c90..10330eb 100644 --- a/assets/demo.js +++ b/assets/demo.js @@ -1,12 +1,6 @@ document.addEventListener('DOMContentLoaded', function() { //console.log(letter) var letter = new LetterLoading('#main', { - strings: [ - "You're lovely... yes you are", - "This is an example string", - "tell me about what more animation you love", - "Lastly, Hey, if you're Bukunmi, I love you" - ], loadspeed: 5 }); @@ -50,7 +44,7 @@ var letter = new LetterLoading('#main', { var letter5 = new LetterLoading('#main5', { strings: [ "Do this...", - "..with cautions", + "with caution", ], loadspeed: 3, hideChaar: false, diff --git a/debug.log b/debug.log index 0142f06..e996db0 100644 --- a/debug.log +++ b/debug.log @@ -1,3 +1,4 @@ [1026/074911.818:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3) [1027/161142.979:ERROR:file_io.cc(135)] WriteFile: The pipe is being closed. (0xE8) [1030/062727.343:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3) +[1101/140324.004:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3) diff --git a/index.html b/index.html index 717632f..1eb0a01 100644 --- a/index.html +++ b/index.html @@ -20,12 +20,6 @@
var letter = new LetterLoading('#main', { - strings: [ - "You're lovely... yes you are", - "This is an example string", - "tell me about what more animation you love", - "Lastly, Hey, if you're Bukunmi, I love you" - ], loadspeed: 5 });@@ -97,7 +91,7 @@
var letter4 = new LetterLoading('#main5', { @@ -116,7 +110,7 @@Check out