From edd7076e75e0c46ad4602737740316c1545c4d59 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Fri, 6 May 2022 13:46:34 +0530 Subject: [PATCH] merge: A better `README` (#1003) * feat: a better README * chore: update repositories link * chore: fix broken links * chore: use gfm `
` syntax Replaced
with ---, which is GitHub Flavoured Markdown syntax. * chore: align everything to be centered * feat: use same style for all badges * chore: use shields.io badge instead of github * chore: reorder badges and add comments * chore: edit and format body * chore: add redirect links to all images * typo: JavasScript -> JavaScript --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 50 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 28180106f..dc1dd436c 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,61 @@ # 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) -![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/) + +JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript. -## All algorithms implemented in JavaScript (for educational purposes only) +
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/TheAlgorithms/Javascript) + [![JavaScript Banner][banner]](DIRECTORY.md) -These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library -that are much better for performance reasons. + [![Language grade: JavaScript][grade]][lgtm] + [![Checks][checks]][actions] + [![Contributions Welcome][welcome]](CONTRIBUTING.md) + [![standard.js][standard-logo]][standard-js] + [![Discord chat][chat]][discord-server] -## Contribution Guidelines + +
-Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. +--- -## List of Algorithms + -See our [directory](DIRECTORY.md). +

+ 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. +

-## Algorithm Explanation +--- + + + +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 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]. + +--- + + +[banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png + + +[standard-logo]: https://img.shields.io/badge/code%20style-standardjs-%23f3df49 +[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 +[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 +[help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 -See our [wiki](https://github.com/TheAlgorithms/Javascript/wiki).