From 33c1e52f2706752daba6110083aba2076040ff1d Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 11:39:40 +0530 Subject: [PATCH 01/11] feat: a better README --- README.md | 43 +++++++++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 28180106fa..2beeba82aa 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,39 @@ # The Algorithms - JavaScript -[![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](CONTRIBUTING.md) -[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square)](https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript) +JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript. + +![JavasScript Banner](https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png) + +[![Contributions Welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](CONTRIBUTING.md) +[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square)](lgtm) ![Node CI](https://github.com/TheAlgorithms/Javascript/workflows/Node%20CI/badge.svg) -![update_directory_md](https://github.com/TheAlgorithms/Javascript/workflows/update_directory_md/badge.svg) -[![Discord chat](https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square)](https://discord.gg/c7MnfGFGa6) -![](https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square) -[![standard.js](https://img.shields.io/badge/code%20style-standardjs-%23f3df49)](https://standardjs.com/) +[![Discord chat](https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square)](discord-server) +![Repository Size](https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square) +[![standard.js](https://img.shields.io/badge/code%20style-standardjs-%23f3df49)](standard-js) + +
-## All algorithms implemented in JavaScript (for educational purposes only) +**These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library +that are much better for performance and security reasons. We also do not provide any api stability guarantee.** -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/TheAlgorithms/Javascript) +Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look +at other [TheAlgorithms Repositories](repositories) or the [issues with a +`help wanted` label](help-wanted) for inspiration regarding what to implement. Our maintainers will guide you through +how to make your contribution properly. -These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library -that are much better for performance reasons. +The names of the maintainers of this repository is listed in the [CODEOWNERS](.github/CODEOWNERS) file. -## Contribution Guidelines +You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). -Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. +Explanations of many of the algorithms can be found in out [wiki](explanation). -## List of Algorithms +
-See our [directory](DIRECTORY.md). +[lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript +[discord-server]: https://discord.gg/c7MnfGFGa6 +[standard-js]: https://standardjs.com/ -## Algorithm Explanation +[repositories]: https://github.com/TheAlgorithms +[help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 +[explanation]: https://github.com/TheAlgorithms/JavaScript/wiki -See our [wiki](https://github.com/TheAlgorithms/Javascript/wiki). From 8aa0e8849773a93dde0265bb721ba159f211d763 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 11:58:38 +0530 Subject: [PATCH 02/11] chore: update repositories link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2beeba82aa..9554a49164 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Explanations of many of the algorithms can be found in out [wiki](explanation). [discord-server]: https://discord.gg/c7MnfGFGa6 [standard-js]: https://standardjs.com/ -[repositories]: https://github.com/TheAlgorithms +[repositories]: https://github.com/orgs/TheAlgorithms/repositories [help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 [explanation]: https://github.com/TheAlgorithms/JavaScript/wiki From 0afeeae74a5e655554bd03a040b6fd17881ddbd3 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 12:07:31 +0530 Subject: [PATCH 03/11] chore: fix broken links --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9554a49164..9374bdec54 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript. -![JavasScript Banner](https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png) +![JavasScript Banner][banner] -[![Contributions Welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](CONTRIBUTING.md) -[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square)](lgtm) -![Node CI](https://github.com/TheAlgorithms/Javascript/workflows/Node%20CI/badge.svg) -[![Discord chat](https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square)](discord-server) -![Repository Size](https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square) -[![standard.js](https://img.shields.io/badge/code%20style-standardjs-%23f3df49)](standard-js) +[![Contributions Welcome][welcome]](CONTRIBUTING.md) +[![Language grade: JavaScript][grade]][lgtm] +![Node CI][node-ci] +[![Discord chat][chat]][discord-server] +![Repository Size][repo-size] +[![standard.js][standard-logo]][standard-js]
@@ -17,20 +17,28 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and that are much better for performance and security reasons. We also do not provide any api stability guarantee.** Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look -at other [TheAlgorithms Repositories](repositories) or the [issues with a -`help wanted` label](help-wanted) for inspiration regarding what to implement. Our maintainers will guide you through +at other [TheAlgorithms Repositories][repositories] or the [issues with a +`help wanted` label][help-wanted] for inspiration regarding what to implement. Our maintainers will guide you through how to make your contribution properly. The names of the maintainers of this repository is listed in the [CODEOWNERS](.github/CODEOWNERS) file. You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). -Explanations of many of the algorithms can be found in out [wiki](explanation). +Explanations of many of the algorithms can be found in out [wiki][explanation].
+[banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png + +[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square +[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square [lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript +[node-ci]: https://github.com/TheAlgorithms/Javascript/workflows/Node%20CI/badge.svg +[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square [discord-server]: https://discord.gg/c7MnfGFGa6 +[repo-size]: https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square +[standard-logo]: https://img.shields.io/badge/code%20style-standardjs-%23f3df49 [standard-js]: https://standardjs.com/ [repositories]: https://github.com/orgs/TheAlgorithms/repositories From 1cef47454e52cc52e0cb37574554bb32e963ade9 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 12:20:32 +0530 Subject: [PATCH 04/11] chore: use gfm `
` syntax Replaced
with ---, which is GitHub Flavoured Markdown syntax. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9374bdec54..6bc5ee99f5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and ![Repository Size][repo-size] [![standard.js][standard-logo]][standard-js] -
+--- **These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library that are much better for performance and security reasons. We also do not provide any api stability guarantee.** @@ -27,7 +27,7 @@ You can find a list of the algorithms currently in the repository in the [direct Explanations of many of the algorithms can be found in out [wiki][explanation]. -
+--- [banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png From 8db063275cd6df6d7fc40d6f3d113e8ed74505d7 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 12:34:46 +0530 Subject: [PATCH 05/11] chore: align everything to be centered --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6bc5ee99f5..7397fdd58c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript. +
+ ![JavasScript Banner][banner] [![Contributions Welcome][welcome]](CONTRIBUTING.md) @@ -10,6 +12,8 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and [![Discord chat][chat]][discord-server] ![Repository Size][repo-size] [![standard.js][standard-logo]][standard-js] + +
--- From 221225d7d5e5b84569b0737773721760acda3909 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 12:39:45 +0530 Subject: [PATCH 06/11] feat: use same style for all badges --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7397fdd58c..4953a16c7d 100644 --- a/README.md +++ b/README.md @@ -35,13 +35,13 @@ Explanations of many of the algorithms can be found in out [wiki][explanation]. [banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png -[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square -[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square +[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat +[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat [lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript [node-ci]: https://github.com/TheAlgorithms/Javascript/workflows/Node%20CI/badge.svg -[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square +[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat [discord-server]: https://discord.gg/c7MnfGFGa6 -[repo-size]: https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square +[repo-size]: https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat [standard-logo]: https://img.shields.io/badge/code%20style-standardjs-%23f3df49 [standard-js]: https://standardjs.com/ From 5ebf8c6ffe4c995d19de04bf601801fa1a25a4fe Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 12:46:38 +0530 Subject: [PATCH 07/11] chore: use shields.io badge instead of github --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4953a16c7d..57cb2515de 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and [![Contributions Welcome][welcome]](CONTRIBUTING.md) [![Language grade: JavaScript][grade]][lgtm] -![Node CI][node-ci] +![Checks][checks] [![Discord chat][chat]][discord-server] ![Repository Size][repo-size] [![standard.js][standard-logo]][standard-js] @@ -38,7 +38,7 @@ Explanations of many of the algorithms can be found in out [wiki][explanation]. [welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat [grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat [lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript -[node-ci]: https://github.com/TheAlgorithms/Javascript/workflows/Node%20CI/badge.svg +[checks]: https://img.shields.io/github/workflow/status/TheAlgorithms/JavaScript/Node%20CI?label=checks [chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat [discord-server]: https://discord.gg/c7MnfGFGa6 [repo-size]: https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat From 89701103b6a5057708ca5cee8e874ba607d7fd1d Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 12:53:37 +0530 Subject: [PATCH 08/11] chore: reorder badges and add comments --- README.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 57cb2515de..a012350108 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,25 @@ # The Algorithms - JavaScript + JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript.
-![JavasScript Banner][banner] + ![JavasScript Banner][banner] + + [![Language grade: JavaScript][grade]][lgtm] + ![Checks][checks] + [![Contributions Welcome][welcome]](CONTRIBUTING.md) + [![standard.js][standard-logo]][standard-js] + [![Discord chat][chat]][discord-server] -[![Contributions Welcome][welcome]](CONTRIBUTING.md) -[![Language grade: JavaScript][grade]][lgtm] -![Checks][checks] -[![Discord chat][chat]][discord-server] -![Repository Size][repo-size] -[![standard.js][standard-logo]][standard-js]
--- + + **These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library that are much better for performance and security reasons. We also do not provide any api stability guarantee.** @@ -33,19 +36,21 @@ Explanations of many of the algorithms can be found in out [wiki][explanation]. --- + [banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png -[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat -[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat -[lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript -[checks]: https://img.shields.io/github/workflow/status/TheAlgorithms/JavaScript/Node%20CI?label=checks -[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat -[discord-server]: https://discord.gg/c7MnfGFGa6 -[repo-size]: https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat + [standard-logo]: https://img.shields.io/badge/code%20style-standardjs-%23f3df49 -[standard-js]: https://standardjs.com/ +[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA +[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3 +[checks]: https://img.shields.io/github/workflow/status/TheAlgorithms/JavaScript/Node%20CI?label=checks +[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18 + +[standard-js]: https://standardjs.com/ +[discord-server]: https://discord.gg/c7MnfGFGa6 +[explanation]: https://github.com/TheAlgorithms/JavaScript/wiki [repositories]: https://github.com/orgs/TheAlgorithms/repositories +[lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript [help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 -[explanation]: https://github.com/TheAlgorithms/JavaScript/wiki From ba14c402775b1c60c0900d4f4eecdd4dfc8f20d0 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 13:04:30 +0530 Subject: [PATCH 09/11] chore: edit and format body --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a012350108..1a0afa2710 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,25 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and --- - + -**These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library -that are much better for performance and security reasons. We also do not provide any api stability guarantee.** +

+ These implementations are for demonstrative purposes only. Dedicated implementations of these algorithms and data + structures are much better for performance and security reasons. We also do not provide any api stability guarantee. +

-Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look -at other [TheAlgorithms Repositories][repositories] or the [issues with a -`help wanted` label][help-wanted] for inspiration regarding what to implement. Our maintainers will guide you through -how to make your contribution properly. +--- -The names of the maintainers of this repository is listed in the [CODEOWNERS](.github/CODEOWNERS) file. + -You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). +Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look +at other [TheAlgorithms Repositories][repositories] or the [issues with a "help wanted" label][help-wanted] for +inspiration regarding what to implement. Our maintainers will guide you through how to make your contribution properly +if you make any mistakes. The names of the maintainers of this repository is listed in the [CODEOWNERS](.github/CODEOWNERS) +file. -Explanations of many of the algorithms can be found in out [wiki][explanation]. +You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). Explanations of +many of the algorithms can be found in the [wiki][explanation]. --- From 9413b0374469d7a160e12f46494701425258264f Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 13:17:31 +0530 Subject: [PATCH 10/11] chore: add redirect links to all images --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1a0afa2710..c707f81586 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and
- ![JavasScript Banner][banner] + [![JavasScript Banner][banner]](DIRECTORY.md) [![Language grade: JavaScript][grade]][lgtm] - ![Checks][checks] + [![Checks][checks]][actions] [![Contributions Welcome][welcome]](CONTRIBUTING.md) [![standard.js][standard-logo]][standard-js] [![Discord chat][chat]][discord-server] @@ -32,8 +32,8 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look at other [TheAlgorithms Repositories][repositories] or the [issues with a "help wanted" label][help-wanted] for inspiration regarding what to implement. Our maintainers will guide you through how to make your contribution properly -if you make any mistakes. The names of the maintainers of this repository is listed in the [CODEOWNERS](.github/CODEOWNERS) -file. +if you make any mistakes. The names of the maintainers of this repository is listed in the +[CODEOWNERS file](.github/CODEOWNERS). You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). Explanations of many of the algorithms can be found in the [wiki][explanation]. @@ -53,6 +53,7 @@ many of the algorithms can be found in the [wiki][explanation]. [standard-js]: https://standardjs.com/ [discord-server]: https://discord.gg/c7MnfGFGa6 +[actions]: https://github.com/TheAlgorithms/JavaScript/actions [explanation]: https://github.com/TheAlgorithms/JavaScript/wiki [repositories]: https://github.com/orgs/TheAlgorithms/repositories [lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript From b085d03ef1626c4008b8f9cbf1a28dcefb9926d0 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 13:44:58 +0530 Subject: [PATCH 11/11] typo: JavasScript -> JavaScript --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c707f81586..dc1dd436c1 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ JavaScript Repository of TheAlgorithms, which implements various algorithms and
- [![JavasScript Banner][banner]](DIRECTORY.md) + [![JavaScript Banner][banner]](DIRECTORY.md) [![Language grade: JavaScript][grade]][lgtm] [![Checks][checks]][actions] pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy