Skip to content

Commit 76865c0

Browse files
committed
docs: Improve and update README
1 parent 5a590de commit 76865c0

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,17 @@
1919
2020
## What is this?
2121

22-
**This is a library which provides easy and advanced timers for module
22+
**A library which provides easy and advanced timers for module
2323
developers.**
2424

2525
This project is inspired by
26-
[mk's timer library](https://atelier801.com/topic?f=6&t=875052), so make sure to
27-
support that also :heart:
26+
[mk's timer library](https://atelier801.com/topic?f=6&t=875052), make sure to
27+
support that project too :heart:
2828

2929
**_Background_**
3030

31-
Since normal players - who aren't module members are not allowed to use tfm
32-
module apis timers (`system.newTimer` and `system.removeTimer`) I decided to
33-
create a brand new and an advanced timer system for all!
31+
As normal players - who aren't in module team - aren't allowed to use the Module API's timers (`system.newTimer` and `system.removeTimer`), I decided to
32+
create a brand new, advanced timer system for the benefit of all!
3433

3534
**_There are many capabilities for these timers_**
3635

@@ -43,7 +42,7 @@ create a brand new and an advanced timer system for all!
4342

4443
## How to use?
4544

46-
In order to use this library you need to insert this libraries code in top of
45+
To use this library you need to insert this libraries code in top of
4746
your code.
4847

4948
[Use the full code _(Recommended for studying)_](https://raw.githubusercontent.com/Seniru/Timers4TFM/master/src/timer.lua)
@@ -59,12 +58,10 @@ your code.
5958
```lua
6059
--insert the library code here
6160

62-
tfm.exec.newGame(0) -- You need to load a new map to use this appropriately
63-
6461
local timer1 = Timer("timer1", function() end, 5000, false) -- Creating a very basic timer with a timeout value of 5000
6562

66-
function eventLoop(tc, tr)
67-
Timer.run(tc) -- You need to call this method inside eventLoop to start and process timers
63+
function eventLoop()
64+
Timer.process() -- You need to call this method inside eventLoop to start and process timers
6865
end
6966

7067

@@ -85,8 +82,8 @@ end
8582

8683
Timer("callback", greet, 2000, false, "Seniru", true) --setting the callback to our greet function and pass "Seniru" and true as arguments
8784

88-
function eventLoop(tc, tr)
89-
Timer.run(tc)
85+
function eventLoop()
86+
Timer.process()
9087
end
9188

9289
--Run this code to see the results!
@@ -109,11 +106,11 @@ Timer("looping", function() print("prints") end, 3000, true)
109106
# Contributing
110107

111108
Do you want to contribute this project? Great! There are many way that you can
112-
involve in this work
109+
involve!
113110

114111
<details>
115112
<summary>Creating issues</summary>
116-
You can create issues for the following reasons,
113+
You can create issues for,
117114
<ul>
118115
<li>Something is not working (bug)</li>
119116
<li>Suggestion / Feature request</li>
@@ -123,7 +120,7 @@ involve in this work
123120

124121
<details>
125122
<summary>Creating PRs</summary>
126-
You can submit a PR for the following,
123+
You can submit a PR for,
127124
<ul>
128125
<li>Bug fixes</li>
129126
<li>Improvements</li>

0 commit comments

Comments
 (0)