From 860624fe6aaecc26fefb8700ba094e5a99b48338 Mon Sep 17 00:00:00 2001 From: osamasayed Date: Fri, 28 Oct 2022 17:42:58 +0200 Subject: [PATCH] docs: update references --- .github/workflows/main.yml | 2 +- CONTRIBUTING.md | 10 +++++----- README.md | 8 ++++---- docs/pages/index.mdx | 2 +- docs/theme.config.js | 6 +++--- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 9aae589..d3aa428 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -37,7 +37,7 @@ jobs: publish-module: name: 🎉 Publish to NPM needs: [build] - if: github.repository == 'quranjs/api' && (github.ref == 'refs/heads/master') + if: github.repository == 'quran/api-js' && (github.ref == 'refs/heads/master') runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51bd00e..7329753 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,11 @@ ## Questions -If you have questions about implementation details, help or support, then please use our dedicated community forum at [GitHub Discussions](https://github.com/quranjs/api/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum. +If you have questions about implementation details, help or support, then please use our dedicated community forum at [GitHub Discussions](https://github.com/quran/api-js/discussions) **PLEASE NOTE:** If you choose to instead open an issue for your question, your issue will be immediately closed and redirected to the forum. ## Reporting Issues -If you have found what you think is a bug, please [file an issue](https://github.com/quranjs/api/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [GitHub Discussions](https://github.com/quranjs/api/discussions) +If you have found what you think is a bug, please [file an issue](https://github.com/quran/api-js/issues/new). **PLEASE NOTE:** Issues that are identified as implementation questions or non-issues will be immediately closed and redirected to [GitHub Discussions](https://github.com/quran/api-js/discussions) ## Suggesting new features @@ -18,18 +18,18 @@ If you have been assigned to fix an issue or develop a new feature, please follo - Fork this repository - Install dependencies by running `$ yarn` -- Link `@quranjs/api` locally by running `$ yarn link` +- Link `quran/api-js` locally by running `$ yarn link` - Auto-build files as you edit by running `$ yarn start` - Implement your changes and tests to files in the `src/` directory and corresponding test files - To run examples, follow their individual directions. Usually this is just `$ yarn && yarn start`. -- To run examples using your local build, link to the local `@quranjs/api` by running `$ @quranjs/api` from the example's directory +- To run examples using your local build, link to the local `quran/api-js` by running `$ quran/api-js` from the example's directory - Document your changes in the appropriate doc page, if needed - Git stage your required changes and commit (see below commit guidelines) - Submit PR for review ## Commit message conventions -`@quranjs/api` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). +`quran/api-js` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. diff --git a/README.md b/README.md index 53c3d7d..44d2d23 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Quranjs Api Header](https://github.com/quranjs/api/raw/master/media/repo-header.png) +![Quranjs Api Header](https://github.com/quran/api-js/raw/master/media/repo-header.png) A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser. [Checkout Docs][docs] @@ -31,10 +31,10 @@ you can visit the [docs][docs] for more details. [qdc-api]: https://quran.api-docs.io/ [docs]: https://quranjs.vercel.app/ -[build-badge]: https://github.com/quranjs/api/workflows/CI/badge.svg -[build]: https://github.com/quranjs/api/actions?query=workflow%3ACI +[build-badge]: https://github.com/quran/api-js/workflows/CI/badge.svg +[build]: https://github.com/quran/api-js/actions?query=workflow%3ACI [license-badge]: https://badgen.net/github/license/quranjs/api -[license]: https://github.com/quranjs/api/blob/master/LICENSE +[license]: https://github.com/quran/api-js/blob/master/LICENSE [npm]: https://www.npmjs.com/package/@quranjs/api [npm-badge]: https://badgen.net/npm/v/@quranjs/api [downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index 0d3b2d9..e39dab2 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -9,7 +9,7 @@ import Image from 'next/image' A library for fetching quran data from the [Quran.com API](https://quran.api-docs.io/). This library also works on both Node.js and the browser. - [NPM](https://www.npmjs.com/package/@quranjs/api) -- [MIT License](https://github.com/quranjs/api/blob/master/LICENSE) +- [MIT License](https://github.com/quran/api-js/blob/master/LICENSE) ## Installation diff --git a/docs/theme.config.js b/docs/theme.config.js index 833cfe5..2ea7cda 100644 --- a/docs/theme.config.js +++ b/docs/theme.config.js @@ -3,11 +3,11 @@ const SEO = { titleSuffix: ' - QuranJS / API', description: 'QuranJS / Api: A library for fetching quran data from the Quran.com API on both Node.js and the browser.', - image: 'https://github.com/quranjs/api/raw/master/media/repo-header.png', + image: 'https://github.com/quran/api-js/raw/master/media/repo-header.png', twitter: '@ahmedriad_', - github: 'quranjs/api', + github: 'quran/api-js', color: '#5120DB', - domain: 'quranjs.vercel.app', + domain: 'www.quranjs.com', } const theme = {