Skip to content

A better README #1003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 6, 2022
67 changes: 50 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)
<!-- Front Matter -->
JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript.

## All algorithms implemented in JavaScript (for educational purposes only)
<div align="center">

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/TheAlgorithms/Javascript)
[![JavasScript 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

</div>

Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
---

## List of Algorithms
<!-- Disclaimer -->

See our [directory](DIRECTORY.md).
<h4 align="center">
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.
</h4>

## Algorithm Explanation
---

<!-- Body -->

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 Image -->
[banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png

<!-- Badge Links -->
[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

<!-- External Links -->
[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).