Skip to content

Commit d8acae7

Browse files
committed
Getting ready for verswion 1.0.0
1 parent f3a673e commit d8acae7

File tree

4 files changed

+101
-69
lines changed

4 files changed

+101
-69
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# WriteIt.js
2-
**_WriteIt.js is lightweight javascript library for text-writing/type-writing effect_**.
2+
**_WriteIt.js is javascript library for text writing effect_**.
33

44
It is completely attribute based system. tweak few attribute and get completly new animation, **you don't need to write single line of javscript :-)**.
55

6-
It is light-weight it can run over 100s of instances simultaneously.
6+
It can run over 100s of instances simultaneously.
77

88
Documentation on: https://khushit-shah.github.io/WriteIt.js
99

@@ -13,8 +13,9 @@ Documentation on: https://khushit-shah.github.io/WriteIt.js
1313
```html
1414
<body writeit-auto-start>
1515
<p writeit-animate>CursorJS is <b>best</b> text writing effect <i>javascript library</i></p>
16-
17-
<script src="/path/to/writeit.min.js"></script>
16+
<script src="/path/to/WriteIt.min.js"></script>
17+
<!--- or -->
18+
<script src="https://cdn.jsdelivr.net/gh/khushit-shah/WriteIt.js@version/WriteIt.min.js"></script>
1819
</body>
1920
```
2021
# Functionalities
@@ -35,12 +36,6 @@ Documentation on: https://khushit-shah.github.io/WriteIt.js
3536
- writeit-wait-in-reverse
3637
- writeit-write-all-in-reverse
3738

38-
# TODO
39-
- [x] functionality to start animation from javascript(i.e. start animation when user scroll etc.).
40-
- [x] Documentation.
41-
- [x] Minification(Closure Advance).
42-
- [x] CDN Creation.
43-
4439
# Issue Template
4540
- Short Description.
4641
- Browser Information.
@@ -49,6 +44,5 @@ Documentation on: https://khushit-shah.github.io/WriteIt.js
4944
- If you want new functionality, Add it to title.
5045

5146
# TODO
52-
- Create portfolio example.
5347
- Add functionality to repeat the animation for specific number of times
5448
- writeit-loop='&lt;x&gt;' : to repeat the animation x number of times

docs/assets/img/portfolio.png

58.2 KB
Loading

0 commit comments

Comments
 (0)