Skip to content

Commit

Permalink
docs: renamed prayers.ts to prayers-call
Browse files Browse the repository at this point in the history
  • Loading branch information
khawarizmus committed Sep 20, 2023
1 parent fb2d9a3 commit f804165
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Prayes.ts

[![npm version](https://badge.fury.io/js/prayers.ts.svg)](https://badge.fury.io/js/prayers.ts)
# Prayes-call

Reactive prayer times calculation library for node and the browser built with Typescript.

[![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
>
Expand All @@ -14,7 +14,7 @@ Reactive prayer times calculation library for node and the browser built with Ty
## Installation

```bash
npm install --save prayers.ts
npm install --save prayers-call
```

## Usage
Expand Down
10 changes: 5 additions & 5 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { version } from '../../package.json'

// if version doesn't work we need to use this plugin https://github.com/semantic-release/git
export default defineConfig({
title: 'Prayers.ts',
title: 'prayers-call',
description: 'A reactive prayer times calculation library for node and the browser built with Typescript',
ignoreDeadLinks: true, // FIXME: remove this when the docs are mature
lastUpdated: true,
Expand All @@ -15,11 +15,11 @@ export default defineConfig({
},

editLink: {
pattern: 'https://github.com/whiterocktech/prayers.ts/edit/master/docs/:path',
pattern: 'https://github.com/whiterocktech/prayers-call/edit/master/docs/:path',
text: 'Edit this page on GitHub',
},

socialLinks: [{ icon: 'github', link: 'https://github.com/whiterocktech/prayers.ts' }],
socialLinks: [{ icon: 'github', link: 'https://github.com/whiterocktech/prayers-call' }],

footer: {
message: 'Released under the MIT License.',
Expand Down Expand Up @@ -58,11 +58,11 @@ function nav() {
items: [
{
text: 'Changelog',
link: 'https://github.com/whiterocktech/prayers.ts/blob/master/CHANGELOG.md',
link: 'https://github.com/whiterocktech/prayers-call/blob/master/CHANGELOG.md',
},
{
text: 'Contributing',
link: 'https://github.com/whiterocktech/prayers.ts/blob/master/CONTRIBUTING.md',
link: 'https://github.com/whiterocktech/prayers-call/blob/master/CONTRIBUTING.md',
},
],
},
Expand Down
20 changes: 10 additions & 10 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,57 @@

## Overview

Prayers.ts is a reactive library for calculating (Islamic) prayer times. It is built with typescript and can be used for both node and the browser.
prayers-call is a reactive library for calculating (Islamic) prayer times. It is built with typescript and can be used for both node and the browser.

You can learn more about the rationale behind the project and it's features in the [Why Prayers.ts](./introduction.md#why-this-library) section.
You can learn more about the rationale behind the project and it's features in the [Why prayers-call](./introduction.md#why-this-library) section.

::: warning
Prayers.ts is currently a WIP status. It is already able to make one time calculations but we are still working on the reactive calculations, the API may also change between minor releases.
prayers-call is currently a WIP status. It is already able to make one time calculations but we are still working on the reactive calculations, the API may also change between minor releases.
:::

## Trying Prayers.ts online
## Trying prayers-call online

You can try Prayer.ts online on [StackBlitz](https://stackblitz.com/edit/prayer-ts?file=src%2Fmain.ts,src%2FPrayerTimes.ts&terminal=dev). It runs Prayer.ts directly in the browser, and it is almost identical to the local setup but doesn't require installing anything on your machine.

::: tip
The version installed on StackBlitz might be out of date. if you want to try the latest version you can simply update the dependency in the `package.json`
:::

## Adding Prayers.ts to your project
## Adding prayers-call to your project

The most straightforward way to adding the library is by running the following commands

with npm

```bash
npm i prayers.ts
npm i prayers-call
```

or with yarn

```bash
yarn add prayers.ts
yarn add prayers-call
```

or with pnpm

```bash
pnpm add prayers.ts
pnpm add prayers-call
```

### CDN

You can use Prayer.ts directly from a CDN via a script tag:

```html
<script src="https://unpkg.com/prayers.ts/dist/index.cjs"></script>
<script src="https://unpkg.com/prayers-call/dist/index.cjs"></script>
```

Here we are using [unpkg](https://unpkg.com), but you can also use any CDN that serves npm packages, for example [jsdelivr](https://www.jsdelivr.com/) or [cdnjs](https://cdnjs.com/). Of course, you can also download this file and serve it yourself.

### Deno

Unlike Node, Deno relies on direct URL imports instead of a package manager like NPM. Prayers.ts is available on [deno.land/x](https://deno.land/x). The latest version can be imported like so:
Unlike Node, Deno relies on direct URL imports instead of a package manager like NPM. prayers-call is available on [deno.land/x](https://deno.land/x). The latest version can be imported like so:

```ts
import { StaticCalculator } from 'https://deno.land/x/prayers'

Check warning on line 58 in docs/guide/getting-started.md

View workflow job for this annotation

GitHub Actions / Lint

'StaticCalculator' is defined but never used
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: home

title: Prayers.ts
title: prayers-call
titleTemplate: A Reactive Prayer Times Calculator

hero:
name: Prayers.ts
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.
actions:
Expand All @@ -14,7 +14,7 @@ hero:
link: /guide/getting-started
- theme: alt
text: View on GitHub
link: https://github.com/whiterocktech/prayers.ts
link: https://github.com/whiterocktech/prayers-call

features:
- title: 'Accurate'
Expand Down

0 comments on commit f804165

Please sign in to comment.