It's very easy to release a package to the world, but for people to use our package, we should add a readme file so they can know how to use our package.
Create a file called
README.md in the package folder we created earlier and add the following code snippet:
# ReactiveTimer This package can run reactive functions in a given interval. ## Installation $ meteor add meteor-book:reactive-timer ## Usage To use the timer, instantiate a new interval: var myTimer = new ReactiveTimer(); Then you can start an interval of 10 seconds using: myTimer.start(10); To use the timer just call the following in any reactive function: myTimer.tick(); To stop the timer use: myTimer.stop();
As we can see, this file uses the markdown ...