diff --git a/README.md b/README.md index 2e7f1dc..39991ed 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,6 @@ Reactive prayer times calculation library for node and the browser built with Ty [![npm version](https://badge.fury.io/js/prayers-call.svg)](https://badge.fury.io/js/prayers-call) -> **Warning** -> This library is a work in progress -> -> - it might not be production ready yet. -> - the api might change. -> - the docs are still in progress - ## Installation ```bash @@ -33,20 +26,3 @@ npm install --save prayers-call ## License [MIT](./LICENSE) License © 2022 [WhiteRock](https://github.com/whiterocktech) - -## TODO - -- add and document a debug mode -- document the creation of a new Prayer object instance - - document all the options available to the user - - list what's the default values - - list what's the meaning of each option - - list the available methods - - list the params of these methods -- document how to use the Formatter object instance - - I18n -- document how to build your own formatter - - Hijri dates? -- Testing your code - - how to use timers to go to the past or the future - - how to use marble tests to test the expected outputs diff --git a/docs/index.md b/docs/index.md index 60c1994..4216f6c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,12 +2,12 @@ layout: home title: prayers-call -titleTemplate: A Reactive Prayer Times Calculator +titleTemplate: Reactive Prayer Times Calculator hero: - name: prayers-call - text: A Reactive Prayer Times Calculator - tagline: Easy to use, Configurable, and Accurate. All you need to get Prayer times calculations done right. + name: Prayers-Call + text: Reactive Prayer Times Calculator + tagline: Effortless, Customizable, and Precise. All you need to get prayer time calculations done right. actions: - theme: brand text: Get Started